各位公司的 API 接口文档是用的什么方式？

2018 年 7 月 18 日
 aschoolboy

之前公司的 API 接口文档写在 word 里，放在 github 上。
缺点很多，不能同时编辑，一同时编辑就冲突.
我趁一期项目结束，搭了个开源 API 接口网站：eolinker。
给师父看了，说可以，叫我把所有接口都牵进去了。准备让所有同事用了。
结果有的同事一看感觉不方便，说可以用 markdown 来写。
又安排我找个用 markdown 写的 api 文档模板

所以想问问大家的 api 接口文档是采用什么方式的？

26280 次点击
所在节点    程序员
117 条回复
ioc
2018 年 7 月 18 日
@TommyLemon 我就说一句，你这个除了 mysql，其他数据库都不支持
opengps
2018 年 7 月 18 日
注释自动生成的 webapi 说明文档
keenwon
2018 年 7 月 19 日
nei 了解下 https://nei.netease.com/
chenry
2018 年 7 月 19 日
什麼方式？不存在的。。。
問 Dev 是 Get 還是 POST ？你都試一下
問參數是什麼格式的？你看一下代碼

運維天天和我吐槽~~
ivanchou
2018 年 7 月 19 日
拿阿里的 Rap 改良的
loveCoding
2018 年 7 月 19 日
走 rpc ,传输用的 pb 协议 ,感觉还不错
Ethanp
2018 年 7 月 19 日
showdoc
xiaqi
2018 年 7 月 19 日
showdoc
lrh3321
2018 年 7 月 19 日
postman 或者手写 openapi 3.0 格式的文档，然后放到 swagger ui 上看。文档和手动测试一体化，就是后端累死了
BaiMax
2018 年 7 月 19 日
在用 showdoc,有一键模板
justfindu
2018 年 7 月 19 日
word 方式可以试试 QQ 的文档共享编辑那个. 真的还挺棒的
947211232
2018 年 7 月 19 日
搭建内网 github，使用 gitbook 建档
smilenceX
2018 年 7 月 19 日
听说过德鲁依没？
CFO
2018 年 7 月 19 日
swagger 改代码时顺手就把文档维护了 本身支持在线文档 也可以用其他工具导出 html pdf
oppressed6370
2018 年 7 月 19 日
apizza，不过文件夹下不能建立子文件夹
v2chou
2018 年 7 月 19 日
口口相传 心累 我是前端
ofooo
2018 年 7 月 19 日
我最近尝试用蚂蚁金服出的语鹊，楼主去看看怎么样吧，不涉及机密的话感觉还不错
LeungJZ
2018 年 7 月 19 日
口口相传+1.
Flicker
2018 年 7 月 19 日
就直接用 markdown 写的，文档这个东西只要有一定规范，大家都能看懂就行了。
cqu1980
2018 年 7 月 19 日
apidoc~~~~~~~~~~~~~~~~

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

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

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

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

© 2021 V2EX