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

2017 年 2 月 16 日
 jimyan

api   文档是用 wiki 还是 doc

19238 次点击
所在节点    程序员
102 条回复
liyu001989
2017 年 2 月 16 日
odirus
2017 年 2 月 16 日
尝试过很多,不过现在都转入了 doc ,模板建立好之后,还是挺方便的。
tjxiter
2017 年 2 月 16 日
没有 API 文档。。。
PICKSOMETHING
2017 年 2 月 16 日
quip
mcfog
2017 年 2 月 16 日
内嵌在代码中,验证参数和展示文档调用同一个来源
nashxk
2017 年 2 月 16 日
confluence ,有个问题是,后来新增的很多字段,都会忘记更新上去。。而且支持 MarkDown 还需要安装插件好像。。
solee
2017 年 2 月 16 日
apidoc
amon
2017 年 2 月 16 日
markdown+gitlab
ixiaozhi
2017 年 2 月 16 日
意念传输
wmttom
2017 年 2 月 16 日
Swagger +3
代码生成文档,或者文档生成代码,一旦各自独立书写总会产生不一致。
jimyan
2017 年 2 月 16 日
@odirus doc 多人编辑和同步很麻烦。当然谷歌 doc 是可以的
kaka8wp
2017 年 2 月 16 日
swagger+1
kenshinhu
2017 年 2 月 16 日
我这边是在用 node 的 apidoc 。。。。。
xwartz
2017 年 2 月 16 日
postman
settings
2017 年 2 月 16 日
Swagger 可以在线调试,根据文档 API 还能反射出静态文档
lc4t
2017 年 2 月 16 日
swagger+quip
MasterC
2017 年 2 月 16 日
有道云协作 + markdown
zyue
2017 年 2 月 16 日
使用 wiki 配合 jira 挺好用的
klgd
2017 年 2 月 16 日
@yxzblue
@StevenTong
@lifesimple
@wmttom
@kaka8wp
@settings
@lc4t
请教一下, swagger 有版本间的比较吗?
lshero
2017 年 2 月 16 日
Confluence 编辑文档浏览器天天卡死

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

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

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

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

© 2021 V2EX