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

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

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

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

22976 次点击
所在节点    程序员
117 条回复
joeke
2018-07-19 09:14:03 +08:00
showdoc apizz 都比较好用
jasonslyvia
2018-07-19 09:18:40 +08:00
swagger + pont + ts,如丝般顺滑
jianlu
2018-07-19 09:22:38 +08:00
showdoc + 1
adrianXu
2018-07-19 09:35:32 +08:00
swagger2
guoyuchuan
2018-07-19 09:38:45 +08:00
swagger
TommyLemon
2018-07-19 09:53:03 +08:00
@adrianXu 你是怎么发出图片的?
adrianXu
2018-07-19 09:55:10 +08:00
@TommyLemon #46 截图 command+v
CabalPHP
2018-07-19 09:56:12 +08:00
jinhan13789991
2018-07-19 09:57:14 +08:00
后台口头传述,绝对不会泄露
specita
2018-07-19 10:02:01 +08:00
在用 Apiary,不过语法要了解下不怎么方便,学习成本有点高, 正准备换
IMuMa3
2018-07-19 10:03:17 +08:00
eoLinker +1
lydbilibili
2018-07-19 10:06:18 +08:00
没有文档
Heanes
2018-07-19 10:09:06 +08:00
swagger 或者 rap
tt67wq
2018-07-19 10:40:59 +08:00
我司一般靠睿智的程序员去源码里面考古
Smilencer
2018-07-19 10:43:43 +08:00
之前用 swagger,现在我再推广使用 postman collection, 作为后端必须产出文档之一。前端和测试 MM 都夸我好贴心,后端兄弟对我恨子入骨。。。
A555
2018-07-19 10:47:24 +08:00
给个地址 给个例子 自己玩
TommyLemon
2018-07-19 10:55:55 +08:00
https://oscimg.oschina.net/oscnet/f123d05a95009216791d54831d266448cac.jpg

自动生成文档,清晰可读永远最新
自动生成请求代码,支持 Android 和 iOS
自动生成 JavaBean 文件,一键下载
自动管理与测试接口用例,一键共享
自动校验与格式化 JSON,支持高亮和收展

有视频教程哦
apijson.org

GitHub 右上角点 Star 支持下吧,谢谢^_^
github.com/TommyLemon/APIJSON
TommyLemon
2018-07-19 10:56:44 +08:00
TommyLemon
2018-07-19 10:58:27 +08:00
@Smilencer Swagger,APIDoc 等都要后端写大量注解代码啊,能不恨你么哈哈?
用 APIJSONAuto 好了,全自动生成,一行代码都不用写
linxl
2018-07-19 11:00:21 +08:00
粘贴一段 json, 附上 url, method. 哈哈哈

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

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

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

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

© 2021 V2EX