我是公司后端开发,目前公司接口使用的是 word 记录,在 svn 上 管理的。 现在一个工程的接口文档到了快 200 页,电脑编辑保存下文档真是卡的不行。
想问下大家都是管理接口文档的,最好是离线的,公司不允许接口文档上外网。
101
kenshinhu 2019-06-05 23:00:56 +08:00
apidoc + 1
|
102
zpf124 2019-06-06 09:08:01 +08:00
@changwei 你如果无聊的话, 你可以每天关注一下 v2 的 java 版块的话题.
然后你就能发现一只复读机, 涵盖了大部分话题, 只要话题和 ORM, http Server,Restful 这几个任意一个有一丁点关联, 他都会自说自话到他的 APIJSON. 你要是单纯听他吹,感觉他一个项目比 Spring 全部项目都万能. 除了不能生孩子没有他的的框架做不了的. |
103
serge001 2019-06-06 09:18:57 +08:00
eolinker+1
|
104
ideaa 2019-06-06 09:19:21 +08:00
PHP 的话可以写在注释里,扫描控制器类目录反射获取注释内容就可以了,几年前就一直这样用,很方便
|
106
TommyLemon 2019-06-06 10:16:24 +08:00
@zpf124 "一个项目比 Spring 全部项目都万能. 除了不能生孩子没有他的的框架做不了的."
这是你帮我吹的吧?不要误导新人了,都去看看发帖纪录好了 https://www.v2ex.com/tag/apijson |
107
tiedan 2019-06-06 10:30:04 +08:00
apib
|
109
wongy 2019-06-06 11:17:21 +08:00
eolinker
|
110
tt67wq 2019-06-06 11:25:56 +08:00
@TommyLemon #26 非 java 能用不啦
|
111
TommyLemon 2019-06-06 14:30:36 +08:00
@Macolor21 无非是猜的,block 了压根看不到
|
112
TommyLemon 2019-06-06 14:36:53 +08:00
@tt67wq
自动化接口管理工具 APIJSONAuto ? 类似 Postman,和语言无关,不侵入代码,任何语言都支持的。 自动化接口与文档 ORM 库? 提供 Node(TypeScript), Python, PHP, Java, C#, Go 后端库 + Android,iOS,JavaScript,Vue 的前端(客户端) Demo |
113
TommyLemon 2019-06-06 14:37:48 +08:00
@TommyLemon
自动化接口管理工具 APIJSONAuto ? 类似 Postman,和语言无关,不侵入代码,任何语言都支持的。 自动化接口与文档 ORM 库 APIJSON ? 提供 Node(TypeScript), Python, PHP, Java, C#, Go 后端库 + Android,iOS,JavaScript,Vue 的前端(客户端) Demo GitHub 上都能搜到,或者随便谷歌,百度等搜索下都能找到 |
114
TommyLemon 2019-06-06 14:41:13 +08:00
@changwei Vue 也是一堆人喷,不用管喷子,只看项目是否适合自己,提升效率,用得舒服 就行了
|
115
momo733 2019-06-06 14:55:44 +08:00
我是使用自动编译部署前,先进行自动测试,把测试结果生成接口文档推送到语雀上,每次增加接口都得写测试。
|
119
smartdoc647 2019-10-22 20:40:31 +08:00
觉得其他工具复杂的可以试下 smart-doc,完全不用不写注解。虽然没有名气,但是针对 springboot 技术栈的接口扫描生成文档来说是很智能的。
|
120
balabalaguguji 2019-10-30 18:44:55 +08:00
赶紧收下,https://easydoc.top
|
121
balabalaguguji 2019-10-31 15:56:20 +08:00
|
122
WillingXyz 2020-03-30 10:40:46 +08:00
@anankun 推荐 https://github.com/Willing-Xyz/RestDoc,无侵入,根据 javadoc 生成 swagger/openapi 规范
|
123
WillingXyz 2020-03-30 10:44:56 +08:00
@anankun 推荐 WilingXyz/RestDoc,无侵入,根据 javadoc 生成 swagger/openapi 规范,也可以导入到 yapi 中
|
124
WillingXyz 2020-03-30 10:47:17 +08:00
推荐一个自己写的开源库 Willing-Xyz/RestDoc
根据 javadoc 生成 swagger 文档,代码完全无侵入 |
125
JsonTu 2020-04-27 20:20:29 +08:00 via iPhone
word 文档,分服务,也觉得不好
|
126
andychen1 2020-09-04 15:43:37 +08:00
这个如何? api-mom
|
127
apifox 2020-09-19 21:33:12 +08:00
Apifox,绝对最好用,没有之一
|
128
funing 2020-09-23 10:17:39 +08:00
一直在用 apizza,朋友公司搞的,比较低调不太会营销,前腾讯产品 + 前阿里技术搞的,和我关系很好,帮忙推荐一下啦。
|
129
balabalaguguji 2021-03-24 18:00:38 +08:00
易文档是用过最好用的
|
130
lizy0329 2021-10-12 10:03:22 +08:00
说用 swagger 管理的人,脑子准是有 da 毛病
|