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

2020-06-11 17:55:58 +08:00
 yedaxia

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

学习成本：

约等于 0 。

功能特性

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

GitHub：JApiDocs 源码

文档介绍：JApiDocs 文档

2604 次点击
所在节点    分享创造
9 条回复
kifile
2020-06-12 10:39:20 +08:00
和 Dagger 实现的功能很像，但是额外解析了注释信息，不过 Dagger 也有注解。所以是一个不用注解的 Dagger?
gz911122
2020-06-12 13:17:07 +08:00
@kifile 依赖注入框架的 dagger 吗?
kifile
2020-06-12 15:17:26 +08:00
错了，swagger..
leoWeek
2020-06-12 17:26:18 +08:00
接口注释都要加 @param 这种形式？
yedaxia
2020-06-12 22:12:04 +08:00
不同于 swagger，不需要额外的注释。有用到 @param，但不是只通过 @param 来获取参数信息，具体可以查看使用文档，基本上是开箱即用的。
yedaxia
2020-06-12 22:13:37 +08:00
@yedaxia 额外的注释 = 额外的注解，逃~~
ygmyth
2020-07-13 00:26:26 +08:00
不支持 json 导出吗
param
2020-07-24 21:11:03 +08:00
看起来大家很需要我呢
yedaxia
2020-07-24 23:34:07 +08:00
@param 你终于来了~

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

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

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

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

© 2021 V2EX