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

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

api   文档是用 wiki 还是 doc

16414 次点击
所在节点    程序员
102 条回复
liyu001989
2017-02-16 09:38:37 +08:00
apidoc http://apidocjs.com/
odirus
2017-02-16 09:39:26 +08:00
尝试过很多，不过现在都转入了 doc ，模板建立好之后，还是挺方便的。
tjxiter
2017-02-16 09:41:58 +08:00
没有 API 文档。。。
PICKSOMETHING
2017-02-16 09:47:54 +08:00
quip
mcfog
2017-02-16 09:54:51 +08:00
内嵌在代码中，验证参数和展示文档调用同一个来源
nashxk
2017-02-16 10:11:45 +08:00
confluence ，有个问题是，后来新增的很多字段，都会忘记更新上去。。而且支持 MarkDown 还需要安装插件好像。。
solee
2017-02-16 10:15:11 +08:00
apidoc
amon
2017-02-16 10:39:15 +08:00
markdown+gitlab
ixiaozhi
2017-02-16 10:40:46 +08:00
意念传输
wmttom
2017-02-16 10:46:50 +08:00
Swagger +3
代码生成文档，或者文档生成代码，一旦各自独立书写总会产生不一致。
jimyan
2017-02-16 10:48:33 +08:00
@odirus doc 多人编辑和同步很麻烦。当然谷歌 doc 是可以的
kaka8wp
2017-02-16 10:56:33 +08:00
swagger+1
kenshinhu
2017-02-16 10:57:00 +08:00
我这边是在用 node 的 apidoc 。。。。。
xwartz
2017-02-16 10:59:20 +08:00
postman
settings
2017-02-16 11:01:38 +08:00
Swagger 可以在线调试，根据文档 API 还能反射出静态文档
lc4t
2017-02-16 11:08:38 +08:00
swagger+quip
MasterC
2017-02-16 11:10:03 +08:00
有道云协作 + markdown
zyue
2017-02-16 11:12:37 +08:00
使用 wiki 配合 jira 挺好用的
klgd
2017-02-16 11:22:29 +08:00
@yxzblue
@StevenTong
@lifesimple
@wmttom
@kaka8wp
@settings
@lc4t
请教一下， swagger 有版本间的比较吗？
lshero
2017-02-16 11:22:58 +08:00
Confluence 编辑文档浏览器天天卡死

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

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

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

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

© 2021 V2EX