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

2019 年 6 月 5 日
 anankun

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

想问下大家都是管理接口文档的，最好是离线的，公司不允许接口文档上外网。
21650 次点击
所在节点    程序员
130 条回复
poisedflw
2019 年 6 月 5 日
自己部署一套 eolinker
dif
2019 年 6 月 5 日
yapi
NoKey
2019 年 6 月 5 日
@rockyou12 谢谢
thfurior
2019 年 6 月 5 日
别问，问就 doc
jaryur
2019 年 6 月 5 日
@chendy 生成 javadoc 只是第一步，原生的 javadoc 很不便于查询和展示，我是生成了自定义格式的类 javadoc markdown 文件
guiling
2019 年 6 月 5 日
yapi
linvaux
2019 年 6 月 5 日
eolinker
chendy
2019 年 6 月 5 日
@jaryur 是开源的吗？想参考一下
yoshiyuki
2019 年 6 月 5 日
showdoc
Egfly
2019 年 6 月 5 日
Yapi
luman
2019 年 6 月 5 日
apidoc +1 养成改代码前先改文档注释，再写个自动发布脚本。简直不要太舒服
zhangtao
2019 年 6 月 5 日
yapi +1
jaryur
2019 年 6 月 5 日
@chendy 目前还在开发中，用的是 docsify 做展示
blueorange
2019 年 6 月 5 日
swagger-ui.html
newmind
2019 年 6 月 5 日
代码即文档
wc951
2019 年 6 月 5 日
spring restdoc，文档片段写在单元测试里
jiangzhuo
2019 年 6 月 5 日
swagger
lygmqkl
2019 年 6 月 5 日
postman / showdoc

api 文档而已 搞那么复杂干嘛？ 难道你们编程的生活还不够苦难吗？
kindle958
2019 年 6 月 5 日
@acumen 你牛逼
changwei
2019 年 6 月 5 日
@liuxey
@TommyLemon
@Macolor21
@liuxey
@via
萌新弱弱地问一句，他的 api 文档项目有什么问题吗？开源免费为什么要喷啊 = =

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

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

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

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

© 2021 V2EX