公司内部的 api 文档一般如何管理？

2016-11-21 12:48:50 +08:00
 fatedier
没有文档，需要看代码研究各种参数的功能和逻辑，耗时耗力，而让团队共同维护和及时更新文档也不是一件容易的事，想了解下各个公司都是怎么管理的。

1. 有哪些工具比较合适，比如 wiki ？
2. 根据代码注释自动生成是否更加高效和便捷？
3235 次点击
所在节点    问与答
5 条回复
ChenSir
2016-11-21 13:12:45 +08:00
我们公司用的 wiki ，感觉这种方式还不错。但是，也要求文档别写得太水。
tabris17
2016-11-21 13:14:30 +08:00
Confluence
cnnbboy
2016-11-21 14:29:50 +08:00
https://apiblueprint.org/
Ouyangan
2016-11-21 20:24:18 +08:00
自己项目在用这个 , 非常友好方便 , http://swagger.io/
公司....老接口口头相传 , 新接口 md 文档
briclin
2018-09-15 05:38:48 +08:00
swagger 貌似挺好

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

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

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

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

© 2021 V2EX