抛弃 swagger? 这款零成本的 API 文档生成工具,已支持上传到 Yapi, Rap2, Eolinker 多个平台

2021-08-29 15:13:34 +08:00
 MarioLuo

Yapi X

造了个轮子,从源码解析标准 Javadoc 文档和 spring 注解生成文档, 上传到 YApi, Rap2, Eolinker, Copy as cURL.

重点!零学习成本,代码即文档,支持多种 API 管理平台

亮点!开箱即用,账户密码登录,易于二次开发

欢迎试用,喜欢的点个星星支持

3930 次点击
所在节点    Java
27 条回复
tairan2006
2021-08-29 15:23:23 +08:00
yapi 已经停止维护了吧
MarioLuo
2021-08-29 15:59:21 +08:00
@tairan2006 布吉岛,不过 YApi 还是很好用的
siteshen
2021-08-29 16:33:40 +08:00
流水的轮子,铁打的 swagger 。
MarioLuo
2021-08-29 16:40:19 +08:00
@siteshen 哈哈哈,以前我也用 swagger, 不过现在回不去了
MarioLuo
2021-08-29 16:41:22 +08:00
@siteshen 想想年轻的时候再 Rap2 上手写接口文档,那叫痛苦
fkdog
2021-08-29 16:51:10 +08:00
对 swagger 真心喜欢不起来,一打开 swagger 密密麻麻的 annotation 人都要裂开了
siteshen
2021-08-29 16:56:38 +08:00
@MarioLuo 世界因轮子而多彩,也因轮子而混乱。我用 swagger 就是不想写文档(自动生成满足能大部分需求),如无必要,不想在单独的文件里写,也不在注释里写。
cweijan
2021-08-29 17:14:23 +08:00
有个叫 easy-yapi 的插件就是这个功能了.
MarioLuo
2021-08-29 17:35:08 +08:00
@fkdog swagger 主要是标准和生态,各种语言支持还是很完美
MarioLuo
2021-08-29 17:40:18 +08:00
@cweijan 是的,easy-yapi 很强大可配置性非常,不过这个插件还是有不同的地方:
MarioLuo
2021-08-29 17:42:22 +08:00
@MarioLuo Yapi X 的亮点,1. Java 写的易于二次开发,2.支持 Rap2 和 Eolinker,并支持账户密码登录, 为撒要造轮子主要还是因为 easy-yapi 感觉定制不方便, kotlin 写的
MarioLuo
2021-08-29 17:46:23 +08:00
@siteshen 最合适的就是最好的,对比 swagger 主要还是学习成本,代码洁癖问题
balabalaguguji
2021-08-29 19:51:12 +08:00
要不再支持一个易文档的 https://easydoc.net
接口文档: https://easydoc.net/s/31322154/uOeIUcm6/0ESJTGoc
MarioLuo
2021-08-29 23:11:02 +08:00
@balabalaguguji 暂时没打算,目前会优先适配主流的文档平台和打磨文档生成,可考虑 pr 二次开发相对比较简单
iseki
2021-08-30 03:57:24 +08:00
建议支持下 oas 之类的 API 规范,生态多少还有一点,可不敢完全供应商锁定
dbpe
2021-08-30 08:49:18 +08:00
写注解 No

写 Java doc yes
egfegdfr
2021-08-30 09:12:02 +08:00
有款叫 smart-doc 的挺好用
MarioLuo
2021-08-30 10:08:53 +08:00
@iseki 非常好的建议,后续会增加导出 swagger.json, 目前来看各种平台也支持导出 swagger.json, 可以放心使用
MarioLuo
2021-08-30 10:10:04 +08:00
@dbpe 正解,而且结合 spring 框架, 比 apidoc 这种完全使用注解生成的强
MarioLuo
2021-08-30 10:29:05 +08:00
@egfegdfr 很棒的工具,个人偏向于 IDEA 插件,交互更友好些

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

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

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

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

© 2021 V2EX