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

重要更新内容

• 新增 对Jackson框架JsonFormat的支持
• 修复使用`@order` 指定接口自定义序号排序错误 bug
• 基于 SPI 机制开放 smart-doc 的解析扩展能力，支持企业扩展解析内部自定义 Java Web 框架
• 社区基于 vitePress 重构了官方文档

本次版本迭代后企业可以在不修改smart-doc官方源代码以及插件的情况下扩展smart-doc完成对一些内部自定义web框架的解析， 并且仍然可以保证上线产物中没有稳定生成框架相关的代码。

新增贡献者

• @Itswag

非常感谢上面的贡献者积极的参与社区贡献。

致谢

感谢@linwumingshi 同学在本次的版本迭代中作出了非常多的重要共贡献

未来计划

• 新增 GRPC 支持 (欢迎社区开发参与贡献)