用于生成API的文档的方案总结
发布于 2 年前 作者 i5ting 8775 次浏览 最后一次编辑是 1 年前 来自 分享

用于生成API的文档的选项:

  1. 托管
  1. 开源项目 对于RESTful API可以使用apiDoc,aglio,swagger等,对于常规的如类,属性、函数等API可以使用jsDoc,sphinx(python).

从讨论群里整理的,欢迎大家补充

26 回复

又挖出一个 modoc简单又方便[呲牙],一个群友写的

不错不错,顶一下

用DocBox吧,模仿slate的,但是是nodejs实现的

@jingsam 棒棒哒

@Knovour 谢谢啊,看起来不错,去试试

@i5ting 如何永久的开启docbox啊,npm start 一离开就断了

群友说: https://github.com/mulesoft/api-console 这个算是和 RAML 结合的最好的文档生成器,不过居然连个在线的 Demo 都没有 …

有没有什么 mock 服务推荐

@xwartz mock分2种,1种是测试中mock,比如sinon或factory-girl类似的,第二种是直接server端模拟json,这个随便用nodejs里的web框架都行,分分钟的事儿

@i5ting 第二种,需要可编辑的,可产出文档,可以分项目来存储 API ,而不是就前端人员在 Nodejs 里写,简单来说就是需要有增删改查功能。

@xwartz 目前可能swagger是最好的,不过非rest的可能没那么好。另外json-server不错,但不支持生成文档

@i5ting 好的,谢谢。我看下 swagger ,json-server 我之前用过。

马克

来自酷炫的 CNodeMD

我准备发布一个

@zhangshiqiu 用 PM2 管理 Node.js 进程?

TJ的dox简单好用

@xwartz 如果你是想为后台开发以外的人员搭建一个API服务器,可以直接使用这个:http://jsonplaceholder.typicode.com/

@i5ting 你好,socket的怎么生成api文档?

不错<br/><br/><a class=“form” href=“https://github.com/shinygang/Vue-cnodejs”>I‘m webapp-cnodejs-vue</a>

很多API doc生成工具生成API文档需要引入第三方依赖,重度依赖在代码里加注解的方式,并且不支持自动化测试RESTful API。

之前习惯用一款名字为 WisdomTool REST Client,它能够基于测试过的历史记录自动生成精美的RESTful API文档。完全不用引入第三方依赖,不用在代码里添加任何注解。完全跟API代码脱离,任何用户即使不了解API代码,也能够使用WisdomTool REST Client生成API文档。并且支持自动化测试RESTful API,输出精美的测试报告。 轻量级的工具,功能却很精悍哦!

https://github.com/wisdomtool/rest-client

Most of API doc tools do not support automated testing.

Once used a tool called WisdomTool REST Client supports automatically generating exquisite RESTful API documentation based on history testing cases without adding annotations to the code, it also supports automated testing, and outputs exquisite report.

Lightweight tool with very powerful features!

https://github.com/wisdomtool/rest-client

回到顶部