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

2019 年 6 月 5 日
 anankun

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

想问下大家都是管理接口文档的,最好是离线的,公司不允许接口文档上外网。
21650 次点击
所在节点    程序员
130 条回复
kenshinhu
2019 年 6 月 5 日
apidoc + 1
zpf124
2019 年 6 月 6 日
@changwei 你如果无聊的话, 你可以每天关注一下 v2 的 java 版块的话题.
然后你就能发现一只复读机, 涵盖了大部分话题, 只要话题和 ORM, http Server,Restful 这几个任意一个有一丁点关联, 他都会自说自话到他的 APIJSON.

你要是单纯听他吹,感觉他一个项目比 Spring 全部项目都万能. 除了不能生孩子没有他的的框架做不了的.
serge001
2019 年 6 月 6 日
eolinker+1
ideaa
2019 年 6 月 6 日
PHP 的话可以写在注释里,扫描控制器类目录反射获取注释内容就可以了,几年前就一直这样用,很方便
mezi04
2019 年 6 月 6 日
@zsdroid yapi 编辑的时候会感觉很卡嘛?我现在就用的这个,编辑的时候就感觉特别的卡,不知什么原因
TommyLemon
2019 年 6 月 6 日
@zpf124 "一个项目比 Spring 全部项目都万能. 除了不能生孩子没有他的的框架做不了的."
这是你帮我吹的吧?不要误导新人了,都去看看发帖纪录好了
https://v2ex.ih06.com/tag/apijson
tiedan
2019 年 6 月 6 日
apib
Macolor21
2019 年 6 月 6 日
@changwei 因为有些人已经 block 了,都能知道他还在这里发,不否认他的开源精神,厌恶这种运营方式。
wongy
2019 年 6 月 6 日
eolinker
tt67wq
2019 年 6 月 6 日
@TommyLemon #26 非 java 能用不啦
TommyLemon
2019 年 6 月 6 日
@Macolor21 无非是猜的,block 了压根看不到
TommyLemon
2019 年 6 月 6 日
@tt67wq
自动化接口管理工具 APIJSONAuto ?
类似 Postman,和语言无关,不侵入代码,任何语言都支持的。

自动化接口与文档 ORM 库?
提供 Node(TypeScript), Python, PHP, Java, C#, Go 后端库 + Android,iOS,JavaScript,Vue 的前端(客户端) Demo
TommyLemon
2019 年 6 月 6 日
@TommyLemon
自动化接口管理工具 APIJSONAuto ?
类似 Postman,和语言无关,不侵入代码,任何语言都支持的。

自动化接口与文档 ORM 库 APIJSON ?
提供 Node(TypeScript), Python, PHP, Java, C#, Go 后端库 + Android,iOS,JavaScript,Vue 的前端(客户端) Demo

GitHub 上都能搜到,或者随便谷歌,百度等搜索下都能找到
TommyLemon
2019 年 6 月 6 日
@changwei Vue 也是一堆人喷,不用管喷子,只看项目是否适合自己,提升效率,用得舒服 就行了
momo733
2019 年 6 月 6 日
我是使用自动编译部署前,先进行自动测试,把测试结果生成接口文档推送到语雀上,每次增加接口都得写测试。
zhuzhibin
2019 年 6 月 6 日
@ideaa +1 暂时我们也是这么做的 巧用 reflection Api
dodosss
2019 年 6 月 7 日
@xuanbg 你这个 readme.md 文件和输出的样式可以共享一份吗?感谢🙏
xuanbg
2019 年 6 月 7 日
@dodosss 没什么样式呀,我那个是需要对外发布,所以用 typora 导出成 html。
smartdoc647
2019 年 10 月 22 日
觉得其他工具复杂的可以试下 smart-doc,完全不用不写注解。虽然没有名气,但是针对 springboot 技术栈的接口扫描生成文档来说是很智能的。
balabalaguguji
2019 年 10 月 30 日
赶紧收下,https://easydoc.top

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

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

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

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

© 2021 V2EX