话说你司的 API 文档是如何进行管理的？

2017-04-13 10:19:07 +08:00
 ansheng

遇到一个尴尬的问题，我司 API 文档都是使用 markdown 来写的，然而是放在项目目录下面的 README.md 中，但是多人人多的时候修改起来就比较麻烦，就想用有没有一种在线的 API 文档管理程序撒的，石墨固然好，好像不支持 Markdown 所以没打算用。

哎。 Fuck

7920 次点击
所在节点    程序员
98 条回复
ansheng
2017-04-13 14:08:50 +08:00
@tkisme2013
@lusyoe
@linoder
考虑下午玩玩看。
kooze
2017-04-13 14:10:41 +08:00
口耳相传
zhuf
2017-04-13 14:11:36 +08:00
apidoc
ansheng
2017-04-13 14:15:45 +08:00
@kooze 这个吊
snriud
2017-04-13 14:36:41 +08:00
最开始是写在 wiki 里，认认真真，完完整整，慢慢地就不维护了，有人要接口文档的话就用 postman 请求一次，截图发给谁。。。
ansheng
2017-04-13 14:39:09 +08:00
@snriud 我也在用 postman ，因为老大没买这个东，所以还不能做到团队公用，
wudanyang
2017-04-13 14:51:00 +08:00
wiki, 不会调格式
gengqiupeng
2017-04-13 14:54:18 +08:00
小幺鸡在线文档。不过不是用 markdown 写的
kaka8wp
2017-04-13 15:06:39 +08:00
有部分文档但基本上不是最新的，最新的也是靠口耳相传
ivvei
2017-04-13 15:12:31 +08:00
没有文档。自己翻代码
izoabr
2017-04-13 15:18:04 +08:00
口口相传
huigeer
2017-04-13 15:24:25 +08:00
apidoc + 1
ArthurKing
2017-04-13 15:26:06 +08:00
swagger +1
huigeer
2017-04-13 15:27:06 +08:00
更正： ShowDoc
qiu0130
2017-04-13 15:38:56 +08:00
难道没有用 tower 的?
klgd
2017-04-13 15:45:12 +08:00
showdoc + apidoc
showdoc 是前人用的， coding+编辑维护不是方便，后来用 apidoc ，注释直接写在 code 里，然后命令生成，虽然注释在编写时也不是太方便，但感觉对 coding 和维护好一点儿
orderc
2017-04-13 16:08:00 +08:00
gitbook
ansheng
2017-04-13 16:14:40 +08:00
@klgd View 里面加注释确实会给后人一个更方便理解，但我司的风格不适合
ansheng
2017-04-13 16:15:01 +08:00
@qiu0130 我司就用，哈哈。
freezhan
2017-04-13 16:19:46 +08:00
swagger+1

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

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

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

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

© 2021 V2EX