V2EX = way to explore V2EX 是一个关于分享和探索的地方
Sign Up Now For Existing Member Sign In
This topic created in 685 days ago, the information mentioned may be changed or developed.
smart-doc 是一款同时支持 JAVA REST API 和 Apache Dubbo RPC 接口文档生成的工具，smart-doc 利用接口泛型和 javadoc 注释自动分析生成 api 接口文档，不采用任何注解侵入到业务代码中。只需要在项目中引入 smart-doc 提供的 maven 或者是 gradle 插件，然后按照规范写好 javadoc 注释即可生成 api 文档。同时 smart-doc 也支持生成 openapi 和 postman 这些规范的文档，生成后可以直接导入相关工具做测试。
目前在国内已被小米、科大讯飞、同程旅行、快手、马蜂窝、顺丰等知名公司所使用。
仓库地址
https://github.com/TongchengOpenSource/smart-doc
重要更新内容
- 新增 @javadoc 标签支持普通 java 类文档的生成（ ps: smart-doc 生成 javadoc 文档）
- 修复使用 @order 标签时序列号排序不正确的问题，本次修复后用户可以完全自由设置接口类的 order 编号
- 修复 post 接口 content-type 为 form-data 和 urlencoded 时生成 OpenAPI 或者 Postman 导入工具变为 GET 方式的参数填充的 bug.
- 支持扫描 SpringBoot ControllerAdvice 全局异常 Handler 生成 OpenAPI HTTP 错误状态（如 404 、500 等）的描述
本次版本迭代后经过测试，在 Springboot 3.0.0 + 版本下，smart-doc 的 OpenAPI 生成能力甚至优于 springdoc-openapi ，在测试中发现 OpenAPI UI 对于一些接口生成的结构定义存在 bug 。
社区贡献
smart-doc 作为同程旅行大力支持的开源项目，对于社区贡献的 committer ，我们将提供书籍、文化衫等礼品作为奖励，非常欢迎社区用户参与共建。后续社区也会逐步增加其他语言的支持。
未来计划
新增 GRPC 支持（欢迎开发者加入参与社区共建）
 | 1 ByteCat Jun 12, 2024 支持 Kotlin 和 Gradle 吗 |
 | 2 smartdoc647 OP @ByteCat 不支持 Kotlin ，确实有很多用户希望我们支持 Kotlin 和 golang 这些语言，但是社区没有足够精力支持。Java 开发 gradle 和 maven 都可以用。 |
Select Language