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

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

api   文档是用 wiki 还是 doc

16871 次点击
所在节点    程序员
102 条回复
yxzblue
2017-02-16 08:38:17 +08:00
Swagger
kancloud
2017-02-16 08:43:13 +08:00
用看云 可以支持 api 文档在线调试
coldmn3
2017-02-16 08:58:04 +08:00
用的 Confluence, 感觉还行吧，同求推荐。
linkoubian
2017-02-16 09:00:31 +08:00
@coldmn3 同样是 Confluence
loadsome
2017-02-16 09:03:44 +08:00
小幺鸡
Felldeadbird
2017-02-16 09:07:19 +08:00
写工具反射得出 API 文档
jimyan
2017-02-16 09:14:43 +08:00
@Felldeadbird 我们是先文档，除了 API 文档，还有设计文档等
liyj144
2017-02-16 09:24:44 +08:00
参考： https://www.v2ex.com/t/309716#reply9
daben1990
2017-02-16 09:27:04 +08:00
https://github.com/fyddaben/lettuce 我们用的 API Blueprint 语法，然后起了个 mock server ，
SourceMan
2017-02-16 09:27:26 +08:00
口头传述
thanksir
2017-02-16 09:27:26 +08:00
推荐 showdoc ，这个还不错的
chipmuck
2017-02-16 09:28:01 +08:00
通过 gitlab 传 md....
StevenTong
2017-02-16 09:28:27 +08:00
swagger +1
lifesimple
2017-02-16 09:29:54 +08:00
swagger +2
Abigale
2017-02-16 09:31:14 +08:00
没有。
awolfly9
2017-02-16 09:31:16 +08:00
天啦，还有 API 文档,没听说过
superpeaser
2017-02-16 09:34:02 +08:00
Confluence +1
lijinma
2017-02-16 09:35:07 +08:00
raml
Asan
2017-02-16 09:37:05 +08:00
wiki
wawehi
2017-02-16 09:37:30 +08:00
gogs 建个项目 传 .md 上去

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

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

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

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

© 2021 V2EX