V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
MarioLuo
V2EX  ›  Java

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

  •  
  •   MarioLuo ·
    lkqm · 2021-08-29 15:13:34 +08:00 · 3907 次点击
    这是一个创建于 963 天前的主题,其中的信息可能已经有所发展或是发生改变。

    Yapi X

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

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

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

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

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

    写 Java doc yes
    egfegdfr
        17
    egfegdfr  
       2021-08-30 09:12:02 +08:00
    有款叫 smart-doc 的挺好用
    MarioLuo
        18
    MarioLuo  
    OP
       2021-08-30 10:08:53 +08:00
    @iseki 非常好的建议,后续会增加导出 swagger.json, 目前来看各种平台也支持导出 swagger.json, 可以放心使用
    MarioLuo
        19
    MarioLuo  
    OP
       2021-08-30 10:10:04 +08:00
    @dbpe 正解,而且结合 spring 框架, 比 apidoc 这种完全使用注解生成的强
    MarioLuo
        20
    MarioLuo  
    OP
       2021-08-30 10:29:05 +08:00
    @egfegdfr 很棒的工具,个人偏向于 IDEA 插件,交互更友好些
    NoUltimate
        21
    NoUltimate  
       2021-08-30 11:11:34 +08:00
    可以指定自己搭建的 rap2 吗?
    MarioLuo
        22
    MarioLuo  
    OP
       2021-08-30 13:02:10 +08:00
    @NoUltimate 可以指定,如果未配置相关账户密码,点击上传时,会自动弹出提示输入相关信息
    NoUltimate
        23
    NoUltimate  
       2021-08-30 14:11:19 +08:00
    @MarioLuo 我找到配置的地方了,不过上传报错了 Expected a string but was BEGIN_OBJECT,和我 rap 版本( 2.3 )有关系吗,注释只加了类开头和请求开头
    MarioLuo
        24
    MarioLuo  
    OP
       2021-08-30 15:34:02 +08:00
    @NoUltimate Rap2 最新版本才 2.2.3, 可以用淘宝 rap2 官方的测试下,如果还有问题可以在 issues 上沟通下,控制台会打印完整的堆栈信息,另外可以确认下本机能否正常连接到内网 rap2
    Gunn27
        25
    Gunn27  
       2021-08-30 16:32:21 +08:00
    还是用 ApiCat 吧
    liaoberlin
        26
    liaoberlin  
       2021-08-31 10:15:52 +08:00
    如果也能支持解析 swagger 注解或者 javadoc 跟 swagger 注解混用的解析就完美了
    MarioLuo
        27
    MarioLuo  
    OP
       2021-09-01 09:44:20 +08:00
    @liaoberlin 有支持 swagger, 不过目前还没测试过,下个版本会支持
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   4285 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 35ms · UTC 04:06 · PVG 12:06 · LAX 21:06 · JFK 00:06
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.