https://github.com/zhusiqing/api-document

api is displayed by markdown, and visually input data，and Developing...
https://github.com/zhusiqing/api-document

Last synced: over 1 year ago
JSON representation

api is displayed by markdown, and visually input data，and Developing...

• Host: GitHub
• URL: https://github.com/zhusiqing/api-document
• Owner: zhusiqing
• Created: 2020-12-24T09:00:11.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-02-04T07:58:28.000Z (over 5 years ago)
• Last Synced: 2025-02-01T12:45:40.697Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 523 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          



  



文档




  

    支持多种编辑markdown的方式，最后生成文档

  








  

    

  

  

    

  



## 目标与哲学

每次与后端进行接口文档协商，最后输出的接口文档总会有部分写的不清楚或者懒得写一些要求，于是打算通过表单的形式来限制一下。

因为工作的原因一直使用vue进行开发，但是本人想用react进行一些开发，所以这里使用react+typescript开发也是为了学习和实践。

## 先决条件

您需要安装或升级 [Node.js](https://nodejs.org/en/)（> = `12。* `，[Yarn](https://www.jeffjade.com/2017/12/30/135-npm-vs-yarn-detial-memo/) 作为首选）。

## 安装

```bash

yarn

# 如果你没有yarn

npm i

```

## 开发

```bash

yarn start

# 如果你没有yarn

npm run start

```

## 构建

```bash

yarn build

# 如果你没有yarn

npm run build

```

## 屏幕截图

暂无

## 支持

告诉人们他们可以去哪里寻求帮助。它可以是 issue 跟踪器，聊天室，电子邮件地址等的任意组合。

## 路线图

- [ ] 先用基础的库做出并完善一个简易的文档功能

- [ ] 采用一些额外的库进行优化

- [ ] 目前使用的后台服务是自己简单搭建的，不适合公开，后面优化同时去掉一些敏感数据再进行公开

## 执照

[MIT](http://opensource.org/licenses/MIT)

版权所有 (c) 2021-至今，[zhusiqing](https://zsqlm.cn)。

## 项目状态

开发中