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
重要更新
- feat: 设置beetl的类加载器
- feat: 重构 WordXmlEscape 和 HtmlEscape
- fix: 添加对默认验证消息占位符的支持
- feat: 增加 OpenAPI 规范支持：AbstractOpenApiBuilder
- 修复 "pathPrefix" 导致在 "basePath" 和 "paths.url" 中生成重复内容的问题
- feat(openapi): ✨ 添加根据描述或包名生成标签的支持
- fix(openapi): 根据字段类型生成示例值，而不是始终使用 String 类型
- feat: 添加 allowSelfReference 配置以控制自引用
- feat(template): 添加用于确定是否跳过方法文档化的方法
- fix: 修复 map 类型 key 的类型检查错误
- fix: 修复 response 字段使用
@JsonProperty(access = JsonProperty.Access.READ_ONLY)时文档生成错误的问题
新贡献者
- @kienmatu 在 https://github.com/TongchengOpenSource/smart-doc/pull/1039 中首次提交贡献
- @PeiRunWu 在 https://github.com/TongchengOpenSource/smart-doc/pull/1055 中首次提交贡献
- @levinzhang1981 在 https://github.com/TongchengOpenSource/smart-doc/pull/1061 中首次提交贡献
完整更新日志: https://github.com/TongchengOpenSource/smart-doc/compare/3.1.0...3.1.1
社区共建
欢迎对 smart-doc 项目感兴趣的同学们加入我们的社区共建活动。目前，我们针对 Java 的支持已经相当完善，未来计划扩展对 Go 和 Rust 等编程语言的支持。
同时，我们也在积极推进 smart-doc 的国际化发展，致力于打造一个面向全球开发者的开放、包容的社区。