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

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

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

哎。 Fuck

7720 次点击
所在节点    程序员
98 条回复
xuanyan
2017-04-13 10:30:53 +08:00
我们用的 mediawiki 搭建的 api 接口词条
lawmil
2017-04-13 10:39:17 +08:00
既然是 md 写的，推荐个系统 docsify 很方便，样式默认 vue 也可以改其他
ansheng
2017-04-13 10:39:24 +08:00
@xuanyan 可以在线修改吗？我想着尽可能就放内网，
ansheng
2017-04-13 10:41:05 +08:00
@lawmil 这个确实很不错，可以考虑。
hekunhotmail
2017-04-13 10:43:05 +08:00
wiki 不谢
zi
2017-04-13 10:46:58 +08:00
我司用 word 。。真的要哭出声来
AlisaDestiny
2017-04-13 10:52:58 +08:00
apiview.com
ansheng
2017-04-13 10:53:54 +08:00
@zi 心疼你三秒。
ansheng
2017-04-13 10:54:35 +08:00
@AlisaDestiny 贵了点，哈哈。
domty
2017-04-13 11:13:29 +08:00
confluence
tpsxiong
2017-04-13 11:15:41 +08:00
https://nei.netease.com/
linoder
2017-04-13 12:24:46 +08:00
swagger
flyingghost
2017-04-13 12:35:43 +08:00
www.xiaoyaoji.com
可内网部署
h4x3rotab
2017-04-13 12:47:55 +08:00
Google 是和源码目录放在一起的 md 文件，同样加入版本管理，代码审查。然后再搭配一个搜索。
lusyoe
2017-04-13 13:08:45 +08:00
swagger +1
crossoverJie
2017-04-13 13:22:00 +08:00
有 doc 和 wiki
tkisme
2017-04-13 13:22:46 +08:00
swagger +1
nashxk
2017-04-13 13:36:07 +08:00
confluence 。不过没用 markdown ，而且改版的时候更新也不是很及时。。
ansheng
2017-04-13 14:08:13 +08:00
@flyingghost 表示打不开，就是需要内网部署的。
ansheng
2017-04-13 14:08:28 +08:00
@nashxk 没 markdown 真的很痛苦

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

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

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

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

© 2021 V2EX