你们团队都是怎么管理 API 文档的

2017-02-16 08:34:41 +08:00
 jimyan

api   文档是用 wiki 还是 doc

16437 次点击
所在节点    程序员
102 条回复
zhuf
2017-02-16 11:28:56 +08:00
swagger+1
mckelvin
2017-02-16 11:53:46 +08:00
https://apiblueprint.org/ 用 atom 加插件写类似 Markdown 的语法,用 Aglio 渲染成 html 文档, 顺手用 Drakov 生成 mock server 方便前后端分离开发。
kankana
2017-02-16 12:22:52 +08:00
apizza.cc 用的是这个。 postman 后直接文档
caixiexin
2017-02-16 12:26:24 +08:00
用 swagger 可以保持接口跟文档同时更新,但是如果用接口生成文档的方式,源代码会有很多原来放在文档里的说明信息。
不管哪种方式,写文档的工作是省不掉的😂
firstfire
2017-02-16 12:40:36 +08:00
代码里用 Javadoc
API 文档用 Markdown 写用 SVN 管理版本
sobigfish
2017-02-16 12:47:47 +08:00
OpenAPI / Swagger
argon33
2017-02-16 13:02:25 +08:00
文档的维护太难了。。。放在代码库里?
settings
2017-02-16 13:45:40 +08:00
@klgd 版本间的比较指的是文档更新后的对比吗?
geeksu
2017-02-16 13:46:28 +08:00
我们的 API 没有文档。。
AJian
2017-02-16 14:29:14 +08:00
用过 RAP
Ixizi
2017-02-16 14:39:51 +08:00
目前在用 RAP 虽然不喜欢 java
Jackeriss
2017-02-16 14:50:23 +08:00
@ixiaozhi 神圣的 F2 连着我们的思想
loveskyforever
2017-02-16 14:54:50 +08:00
用的是 SBDoc ,可以内网测试, mock 数据,自动生成文档,干净无插件 http://123.57.77.6
Ypoem
2017-02-16 15:04:02 +08:00
支持下
yy1300326388
2017-02-16 16:35:38 +08:00
postmant
zorui
2017-02-16 16:49:24 +08:00
swagger +1
zorui
2017-02-16 16:50:19 +08:00
swagger + asciidoc
v4ex4b
2017-02-16 16:59:30 +08:00
@SourceMan \(≧▽≦)/
irory
2017-02-16 17:59:50 +08:00
推荐自动生成文档, 比如 PY 的 sphinx , api 更新方便维护 ,一键生成也方便。
ivanyin
2017-02-16 18:44:07 +08:00
用 RAP

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

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

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

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

© 2021 V2EX