未分類
24 5 月 2020

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

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

資深大佬 : yedaxia 20

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

学习成本：

约等于 0 。

功能特性

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

GitHub：JApiDocs 源码

文档介绍：JApiDocs 文档

大佬有話說 (6)

  • 資深大佬 : kifile

    和 Dagger 实现的功能很像，但是额外解析了注释信息，不过 Dagger 也有注解。所以是一个不用注解的 Dagger?

  • 資深大佬 : gz911122

    @kifile 依赖注入框架的 dagger 吗?

  • 資深大佬 : kifile

    错了，swagger..

  • 資深大佬 : leoWeek

    接口注释都要加 @param 这种形式？

  • 主 資深大佬 : yedaxia

    不同于 swagger，不需要额外的注释。有用到 @param，但不是只通过 @param 来获取参数信息，具体可以查看使用文档，基本上是开箱即用的。

  • 主 資深大佬 : yedaxia

    @yedaxia 额外的注释 = 额外的注解，逃~~