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 生成错误
更多更新内容请查看官方仓库发版日志
未来计划
AI 虽然聪明，但是当前 smart-doc 服务的领域无论是在生成速度和准确度都远超 AI, 未来我们会持续更新支持 idea 插件
Select Language