抛弃 swagger? 这款零成本的 API 文档生成工具，已支持上传到 Yapi, Rap2, Eolinker 多个平台
MarioLuo · lkqm · 2021-08-29 15:13:34 +08:00 · 4278 次点击这是一个创建于 1216 天前的主题，其中的信息可能已经有所发展或是发生改变。
Yapi X
造了个轮子，从源码解析标准 Javadoc 文档和 spring 注解生成文档, 上传到 YApi, Rap2, Eolinker, Copy as cURL.
重点！零学习成本，代码即文档，支持多种 API 管理平台
亮点！开箱即用，账户密码登录，易于二次开发
欢迎试用，喜欢的点个星星支持
- IDEA 插件地址: Yapi X
- Github: https://github.com/jetplugins/yapix
 |
1
tairan2006 2021-08-29 15:23:23 +08:00
yapi 已经停止维护了吧
|
 |
2
MarioLuo OP @tairan2006 布吉岛，不过 YApi 还是很好用的
|
 |
3
siteshen 2021-08-29 16:33:40 +08:00  3
流水的轮子，铁打的 swagger 。
|
 |
6
fkdog 2021-08-29 16:51:10 +08:00
对 swagger 真心喜欢不起来，一打开 swagger 密密麻麻的 annotation 人都要裂开了
|
|
7
siteshen 2021-08-29 16:56:38 +08:00
@MarioLuo 世界因轮子而多彩，也因轮子而混乱。我用 swagger 就是不想写文档（自动生成满足能大部分需求），如无必要，不想在单独的文件里写，也不在注释里写。
|
 |
8
cweijan 2021-08-29 17:14:23 +08:00
有个叫 easy-yapi 的插件就是这个功能了.
|
|
11
MarioLuo OP @MarioLuo Yapi X 的亮点，1. Java 写的易于二次开发，2.支持 Rap2 和 Eolinker，并支持账户密码登录， 为撒要造轮子主要还是因为 easy-yapi 感觉定制不方便, kotlin 写的
|
 |
13
balabalaguguji 2021-08-29 19:51:12 +08:00
|
|
14
MarioLuo OP @balabalaguguji 暂时没打算，目前会优先适配主流的文档平台和打磨文档生成，可考虑 pr 二次开发相对比较简单
|
 |
15
iseki 2021-08-30 03:57:24 +08:00 via Android
建议支持下 oas 之类的 API 规范，生态多少还有一点，可不敢完全供应商锁定
|
 |
16
dbpe 2021-08-30 08:49:18 +08:00
写注解 No
写 Java doc yes |
 |
17
egfegdfr 2021-08-30 09:12:02 +08:00
有款叫 smart-doc 的挺好用
|
|
18
MarioLuo OP @iseki 非常好的建议，后续会增加导出 swagger.json， 目前来看各种平台也支持导出 swagger.json， 可以放心使用
|
 |
21
NoUltimate 2021-08-30 11:11:34 +08:00
可以指定自己搭建的 rap2 吗？
|
|
22
MarioLuo OP @NoUltimate 可以指定，如果未配置相关账户密码，点击上传时，会自动弹出提示输入相关信息
|
|
23
NoUltimate 2021-08-30 14:11:19 +08:00
@MarioLuo 我找到配置的地方了，不过上传报错了 Expected a string but was BEGIN_OBJECT，和我 rap 版本（ 2.3 ）有关系吗，注释只加了类开头和请求开头
|
|
24
MarioLuo OP @NoUltimate Rap2 最新版本才 2.2.3, 可以用淘宝 rap2 官方的测试下，如果还有问题可以在 issues 上沟通下，控制台会打印完整的堆栈信息，另外可以确认下本机能否正常连接到内网 rap2
|
 |
25
Gunn27 2021-08-30 16:32:21 +08:00
还是用 ApiCat 吧
|
 |
26
liaoberlin 2021-08-31 10:15:52 +08:00
如果也能支持解析 swagger 注解或者 javadoc 跟 swagger 注解混用的解析就完美了
|
|
27
MarioLuo OP @liaoberlin 有支持 swagger， 不过目前还没测试过，下个版本会支持
|
Select Language