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 等）的描述
  • 优化 ExampleBody 样例构建代码，以去除重复代码（ps: 一个来自在飞机上写下的PR）
  • 泛型替换错误导致的解析 bug，例如构建一个多叉树对象结构体时。
  • 优化：优化并重构smart-doc代码中很对常量定义，拓展了接口HTTP 错误状态自定生成能力。

本次版本迭代后经过测试，在Springboot 3.0.0+版本的框架下，smart-doc的OpenAPI生成能力甚至优于springdoc-openapi，在测试中发现OpenAPI UI对于一些接口生成的结构定义存在bug。

新增贡献者

本次更新新增 2 位新的社区贡献者，非常感谢上面的两位贡献者积极的参与社区贡献。为社区的发展起到了非常积极的作用。

未来计划

  • 新增 GRPC 支持(欢迎社区开发参与贡献)
免责声明：本文系转载，版权归原作者所有；旨在传递信息，不代表一休教程网的观点和立场。