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

重要更新

• 支持从 Java 类提取 @APinote 信息作为详细描述
• 为html输出文档代码块添加复制按钮插件
• 新增 Dubbo RPC 的 dubboMethod 字段支持，方便在Torna中测试dubbo接口
• 修复 OpenAPI 文档中 pathPrefix 生成错误
• 解决 OpenAPI 标签名与配置策略不匹配的问题
• 修正 @FeignClient 的 path 属性支持并重构注解常量
• 修复枚举值为空时的数组越界异常
• 修复 gRPC 文档生成对按包组织的 proto 文件的支持
• 修复非 JSON 枚举类型在 Torna 推送中的显示错误及配置转换问题
• 升级 DataFaker 至 1.9.0

完整更新日志: https://github.com/TongchengOpenSource/smart-doc/compare/3.1.0...3.1.1

社区共建

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

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