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

主要变更

• 修复(torna): 修复当ContentType为multipart/form-data时保留查询参数的问题。
• 修复: 修正@RequestBody和无注解表单参数的参数文档。
• 重构: 优化API文档请求示例生成逻辑。
• 修复: 修复内部枚举类加载失败问题。
• 功能(markdown): 为markdown文档参数新增'Example'字段。
• 修复(枚举): 多场景下的枚举处理问题。
• 功能(枚举): 修改枚举示例值生成规则。
• 修复(枚举): 枚举数组示例值引号未移除问题。
• 功能(doc): HTML/ADOC/DOC支持示例字段。
• 功能(枚举): 请求头支持枚举类型。
• 支持JDK17文本块语法。
• 性能(枚举): 新增'enumConvertor'配置项。
• 修复: 增强枚举字典生成逻辑
• 修复Window风格显示错误
• 修复Map<Enum, Value>参数解析问题。
• 新增Dubbo接口Word文档生成支持。
• 重构字段自定义逻辑（@linwumingshi提交）
• 修复maxLength常量解析问题
• 支持校验消息占位符解析
• openapi插件生成operationId与springdoc-openapi保持一致。

建议使用用户升级到最新版本，smart-doc 基本可以实现平滑升级。

新贡献者

• 欢迎@zlxs1317169首次贡献（#1011）

社区共建

欢迎对 smart-doc 项目感兴趣的同学们加入我们的社区共建活动。目前，我们针对 Java 的支持已经相当完善，未来计划扩展对 Go 和 Rust 等编程语言的支持。

同时，我们也在积极推进 smart-doc 的国际化发展，致力于打造一个面向全球开发者的开放、包容的社区。