smart-doc 是一个 java restful api 文档生成工具，smart-doc 基于源码和源码注释分析生成文档，全程无侵入。并且易集成。官方已在码云仓库上维护了相关完善的文档供国内使用者参考。smart-doc 目前是 spring boot 技术栈上最好用的 java 文档生成工具。欢迎使用和提出相关改进建议。

功能特性

• 零注解、零学习成本、只需要写标准 java 注释。
• 基于源代码接口定义自动推导，强大的返回结构推导。
• 支持 Spring MVC,Spring Boot,Spring Boot Web Flux(controller 书写方式)。
• 支持 Callable,Future,CompletableFuture 等异步接口返回的推导。
• 支持 JavaBean 上的 JSR303 参数校验规范，支持分组验证。
• 对 json 请求参数的接口能够自动生成模拟 json 参数。
• 支持生成 json 返回值示例。
• 支持从项目外部加载源代码来生成字段注释。
• 支持生成多种格式文档：Markdown 、HTML5 、Postman collection 。
• 插件式快速集成，文档齐全，官方提供了 19 个文档。

项目仓库

smart-doc 的码云仓库链接

github 仓库地址链接

更新内容

1. maven 插件错误码列表导出 buggit #I1EHXA。
2. 增加 @PatchMapping 支持gitee #I1EDRF
3. 解决 javadoc 包含重复 tag 生成文档报错gitee #I1ENNM。
4. 修改当请求参数为泛型时数据解析错误问题。
5. 修复分组验证空指针问题，不对返回对象做分组验证处理。
6. 优化 smart-doc-maven-plugin 对多级 maven 项目的加载。
7. 支持请求参数对象替换成另外的对象来渲染文档

升级建议

入口无变更，建议平滑升级。

相关文档

smart-doc 文档 wiki

smart-doc 的部分用户

• 科大讯飞
• 小米
• 一加

项目活跃度

从 18 年开源至今，在码云和 github 上持续修改了 70 多个用户提出的 issue 。也是当前码云上活跃度比较高的个人开源项目。