V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
yedaxia
V2EX  ›  分享创造

JApiDocs: 无需额外注解的 SpringBoot API 文档生成工具

  •  
  •   yedaxia · 2020-06-11 17:55:58 +08:00 · 2234 次点击
    这是一个创建于 746 天前的主题,其中的信息可能已经有所发展或是发生改变。

    推荐一个本人写的 API 文档生成工具。

    学习成本:

    约等于 0 。

    功能特性

    1. 基于源码解析,无需额外注解配置;
    2. 同步支持 Android 和 iOS Model 类生成;
    3. 支持接口搜索;
    4. 支持不同版本和英文文档;
    5. 支持特性扩展。

    GitHub:JApiDocs 源码

    文档介绍:JApiDocs 文档

    9 条回复    2020-07-24 23:34:07 +08:00
    kifile
        1
    kifile  
       2020-06-12 10:39:20 +08:00
    和 Dagger 实现的功能很像,但是额外解析了注释信息,不过 Dagger 也有注解。所以是一个不用注解的 Dagger?
    gz911122
        2
    gz911122  
       2020-06-12 13:17:07 +08:00
    @kifile 依赖注入框架的 dagger 吗?
    kifile
        3
    kifile  
       2020-06-12 15:17:26 +08:00
    错了,swagger..
    leoWeek
        4
    leoWeek  
       2020-06-12 17:26:18 +08:00
    接口注释都要加 @param 这种形式?
    yedaxia
        5
    yedaxia  
    OP
       2020-06-12 22:12:04 +08:00
    不同于 swagger,不需要额外的注释。有用到 @param,但不是只通过 @param 来获取参数信息,具体可以查看使用文档,基本上是开箱即用的。
    yedaxia
        6
    yedaxia  
    OP
       2020-06-12 22:13:37 +08:00
    @yedaxia 额外的注释 = 额外的注解,逃~~
    ygmyth
        7
    ygmyth  
       2020-07-13 00:26:26 +08:00
    不支持 json 导出吗
    param
        8
    param  
       2020-07-24 21:11:03 +08:00
    看起来大家很需要我呢
    yedaxia
        9
    yedaxia  
    OP
       2020-07-24 23:34:07 +08:00
    @param 你终于来了~
    关于   ·   帮助文档   ·   API   ·   FAQ   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   2118 人在线   最高记录 5497   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 00:27 · PVG 08:27 · LAX 17:27 · JFK 20:27
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.