请问有哪些编写 api 文档的工具推荐?

2017-12-05 21:44:27 +08:00
 serge001

需要和后端共同约定一套 api,所以需要我来编写 api 文档,看了很多目前最流行的 swagger 的文档,不是很懂,我需要的只是编写 api 文档,并不需要 mock 和测试之类,感觉用 swagger 好复杂的样子.找了很久发现阿里的 rap 的 1.0 版本(不是 2.0)比较符合我的需求,但是很无语的一点是定义的参数列表是按照首字母排序的,好不爽.请问还有比较好用的 api 文档编写工具推荐吗?或者说这种情况下 swagger 适合我的需求吗?

6703 次点击
所在节点    API
3 条回复
lizheming
2017-12-05 22:02:23 +08:00
我一直在用 http://apidocjs.com/ 感觉也还不错
zthxxx
2017-12-05 23:52:08 +08:00
docsify https://docsify.js.org/
Docup https://github.com/egojump/docup

这两个的作者都在 v 站
balabalaguguji
2018-12-26 10:51:09 +08:00
推荐你 https://easydoc.xyz 专为 api 文档定制的工具,肯定很适合你

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/412292

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX