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
重要更新内容
- 修复了枚举键和基本类型值的 Map 的空 JSON 示例值问题。
- 修复了解析 `@JsonProperty` 和 `@JSONField` 注解中常量错误的问题。
- 修复了在没有方法时生成 Postman API 文档的 NPE 问题。
- 修复了由于 `EmptyList` 是 final 导致的错误。
- 重构了与 URL 相关的代码。
- 添加了 GitHub Actions 工作流以在 PR 上添加评论。
- 修复了如果查询请求参数中有枚举，生成的请求参数注释将不包含“See”的问题。
- 修复了如果请求参数包含类型“date”且参数名为 endTime 或 beginTime，生成的示例值可能与预期不同的问题。
- 修正了使用 `@JsonValue` 注解的枚举的示例值生成问题。
- 优化了枚举参数类型的处理逻辑。
- 添加了构建和 API 文档生成的 PR 评论通知。
- 修复了由于 isQueryParam 错误引起的Post方法中使用RequestParam的参数展示错误问题。
建议使用用户升级到最新版本，smart-doc基本可以实现平滑升级。
社区共建
欢迎对 smart-doc 项目感兴趣的同学们加入我们的社区共建活动。目前，我们针对 Java 的支持已经相当完善，未来计划扩展对 Go 和 Rust 等编程语言的支持。
同时，我们也在积极推进 smart-doc 的国际化发展，致力于打造一个面向全球开发者的开放、包容的社区。
