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

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

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

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

23545 次点击
所在节点    程序员
117 条回复
pandasoda
2018-07-19 13:04:45 +08:00
@billlee 秀
sakishum
2018-07-19 13:11:36 +08:00
口传心授
iFlicker
2018-07-19 13:24:55 +08:00
@billlee 对的， 反正人家也不看 都是过来问
Heimo
2018-07-19 13:45:14 +08:00
用过 swagger，showdoc，最终使用 apizza
jianpanxia
2018-07-19 13:47:08 +08:00
自己看代码去..
bufpay
2018-07-19 13:48:07 +08:00
(bufpay.com 个人收款 API)[https://bufpay.com/page.html] 直接是 html，用 github 的 wiki 也不错呀
Jameson1559
2018-07-19 14:08:32 +08:00
。。。我们连口口相传都没有。。全靠慧根自己领悟。。。
NSAtools
2018-07-19 14:09:45 +08:00
口口相传，代码连注释也没
NonClockworkChen
2018-07-19 15:28:14 +08:00
虽然是老生常谈，但是挺有用的帖子。。。
fml87
2018-07-19 15:35:15 +08:00
项目立项的时候有详细的设计文档，项目一期用 swagger，二期、三期、四期接口变动超过 90%，人员也换了一轮，API、消息结构、一些部署配置项就全靠口口相传和猜了
TingHaiJamiE
2018-07-19 15:36:00 +08:00
yapi
randyzhao
2018-07-19 15:39:19 +08:00
手写 MD。。。
beny2mor
2018-07-19 15:42:12 +08:00
rap2
TommyLemon
2018-07-19 15:43:07 +08:00
@fml87 Swagger 这种需要后端写大量注解代码的，后期当然维护困难。
用 APIJSONAuto 吧，一行代码都不用写就能自动生成文档
右上角点 Star 支持下吧^_^
github.com/TommyLemon/APIJSON

<img src="https://oscimg.oschina.net/oscnet/f123d05a95009216791d54831d266448cac.jpg" />
TommyLemon
2018-07-19 15:47:06 +08:00
@TommyLemon 效果展示(右侧滚动到自动生成的代码的下方)：
apijson。org
reus
2018-07-19 15:52:46 +08:00
用函数签名做文档，反正前端看得懂，先写文档，然后把文档复制到代码里，改下一些参数类型，然后加上函数体，就实现了接口
sutra
2018-07-19 15:55:24 +08:00
enunciate.
soulmine
2018-07-19 16:00:24 +08:00
没有文档
feiyuanqiu
2018-07-19 16:28:22 +08:00
@TommyLemon 需要程序员写大量注解，就没有把 swagger 用对

nwu2Cv8OZ2MZMg39
2018-07-19 16:29:43 +08:00
rap

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

https://tanronggui.xyz/t/472126

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

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

© 2021 V2EX