|
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
重要更新内容
- 修复了解析
@JsonProperty 和 @JSONField 注解中常量错误的问题。
- 修复了在没有方法时生成 Postman API 文档的 NPE 问题。
- 修正了使用
@JsonValue 注解的枚举的示例值生成问题。
未来计划
新增对其它开发语言的支持, 欢迎对 golang 和 rust 语言感兴趣的同学加入社区，后续一起构建对 golang 和 rust 的支持
| 
