大家接口文档都是怎么管理的。

2019-06-05 11:21:07 +08:00
 anankun

我是公司后端开发,目前公司接口使用的是 word 记录,在 svn 上 管理的。 现在一个工程的接口文档到了快 200 页,电脑编辑保存下文档真是卡的不行。

想问下大家都是管理接口文档的,最好是离线的,公司不允许接口文档上外网。
18608 次点击
所在节点    程序员
130 条回复
zsdroid
2019-06-05 11:28:29 +08:00
yapi
acumen
2019-06-05 11:30:21 +08:00
口口相传,分布式存储在脑海
lihongjie0209
2019-06-05 11:31:07 +08:00
既然是后端, 直接看代码.
Vegetable
2019-06-05 11:32:30 +08:00
现在是 yapi,以前也尝试过 gitbook 来做,怪不方便的.
SirLostWhite
2019-06-05 11:34:49 +08:00
一开始用的 apizza
后来转用 eolinker 还挺好用的
skiy
2019-06-05 11:36:35 +08:00
API 文档?管理平台好多。我在用的是 mindoc。
a330202207
2019-06-05 11:37:54 +08:00
showdoc
doco
2019-06-05 11:38:21 +08:00
之前是 showDoc, 现在是 YAPI, 然而后台都不喜欢写接口文档
rexyan
2019-06-05 11:39:29 +08:00
跟着项目走,传 git
chinvo
2019-06-05 11:40:37 +08:00
openapi + web ui
shuipoqian
2019-06-05 11:42:37 +08:00
yapi , 同时后端集成了 springfox 生成 swagger 文档, 然后 swagger 的文档可以直接导入到 yapi
kevinlm
2019-06-05 11:46:16 +08:00
一杯茶,一盒烟,一个参数传一天
razaura
2019-06-05 11:50:15 +08:00
swagger
introle
2019-06-05 11:51:02 +08:00
swagger +1
Caballarii
2019-06-05 11:53:21 +08:00
肯定 swagger 啊,能直接试比看文档强多了好吧
pengjl
2019-06-05 12:00:38 +08:00
swagger+1
zhuwd
2019-06-05 12:13:07 +08:00
yapi
cccy0
2019-06-05 12:25:15 +08:00
postman
fengxianqi
2019-06-05 12:28:44 +08:00
内网部署 yapi 应该是最合适的了
EastLord
2019-06-05 12:29:44 +08:00
swagger

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

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

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

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

© 2021 V2EX