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

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

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

哎。 Fuck

7732 次点击
所在节点    程序员
98 条回复
yellowV2ex
2017-04-14 08:47:46 +08:00
腾讯微信的公众号开发文档就是 word ，最开始的时候，里面引号还是中文的。
yellowV2ex
2017-04-14 08:48:32 +08:00
推荐一个东西， https://github.com/danielgtaylor/aglio
loading
2017-04-14 08:50:36 +08:00
自己看代码
zongren
2017-04-14 08:54:21 +08:00
QQ 聊天记录
zcwlwen
2017-04-14 09:16:26 +08:00
写 markdown 扔在 gitlab 上
BearD01001
2017-04-14 09:35:43 +08:00
额，公司的 boss 系统有 API 文档检索功能，虽然界面粗糙，不过挺实用
HuntBao
2017-04-14 09:39:57 +08:00
我司自己开发的接口管理系统： https://nei.netease.com/
silenceeeee
2017-04-14 09:42:03 +08:00
写 word 扔 svn ，己准备离职！
stackboom
2017-04-14 09:43:29 +08:00
之前 swagger ，现在 RAP
ansheng
2017-04-14 09:55:23 +08:00
@HuntBao 活捉大神一枚。
Raidal
2017-04-14 09:56:46 +08:00
在用 [aglio]( https://github.com/danielgtaylor/aglio) ，不过数据多了后会有一点点慢。
roricon
2017-04-14 10:33:37 +08:00
sphinx 为啥没人提起呢.
chipmuck
2017-04-14 10:39:43 +08:00
https://www.v2ex.com/t/340795 难怪看的眼熟。。。。
heaunter
2017-04-14 10:43:44 +08:00
必须小幺鸡啊……团队已从 RAP 切换到小幺鸡了
Vvfan
2017-04-14 11:20:08 +08:00
@zongren 你赢了
magiclobster
2017-04-14 15:49:19 +08:00
为什么不用 oschina 啊..
changs1986
2017-04-14 18:58:03 +08:00
apidoc
andychen1
2020-09-04 14:20:56 +08:00
api-mom.com 我司用这个

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

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

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

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

© 2021 V2EX