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

2018-07-18 20:10:15 +08:00
 aschoolboy

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

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

23545 次点击
所在节点    程序员
117 条回复
matthevv
2018-07-19 11:00:45 +08:00
Apidoc🤭
hellopy
2018-07-19 11:01:40 +08:00
我司：svn+word+excel,wiki
fuckgfwfuckgfw
2018-07-19 11:03:30 +08:00
https://github.com/txthinking/frank
zclHIT
2018-07-19 11:06:31 +08:00
IDP-Lite..
yzmm
2018-07-19 11:09:02 +08:00
swagger+markdown
shd
2018-07-19 11:13:32 +08:00
apidoc +1
skyline45
2018-07-19 11:19:09 +08:00
word 啊 2333333333
zavieryip
2018-07-19 11:23:37 +08:00
showdoc+1
whypool
2018-07-19 11:28:03 +08:00
excel
Lawlieti
2018-07-19 11:30:12 +08:00
口述
x537196
2018-07-19 11:33:16 +08:00
魔改 showdoc
cai314494687
2018-07-19 11:38:47 +08:00
自己搭建 eolinker
Light3
2018-07-19 11:43:41 +08:00
https://apiview.com/
这个 人少完全 ok
hasbug
2018-07-19 11:50:34 +08:00
以前 swagger，现在公司 word···好烦人
pandaaa
2018-07-19 11:53:00 +08:00
用的 wiki
TommyLemon
2018-07-19 12:17:58 +08:00
https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_Auto_doc.jpg
TommyLemon
2018-07-19 12:19:04 +08:00
V2EX 评论里发个图片这么麻烦。。。
Edwards
2018-07-19 12:34:40 +08:00
@billlee 皮
NicholasYX
2018-07-19 12:52:44 +08:00
写个页面，罗列按钮，怎么调用直接写按钮点击事件里面，拿去自己点着玩，右键查看源代码 手动滑稽.
xrr2016
2018-07-19 13:01:57 +08:00
之前公司用什么 txt 文件，或者 md，在我的推荐下用了 YApi，很好用的；

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

https://tanronggui.xyz/t/472126

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

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

© 2021 V2EX