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 仓库地址链接

gradle 插件

smart-doc 从开源到现在近两年的时间中，不断有用户提出能否支持 gradle 插件。经过一段时间的开发和测试，现在终于发布了 smart-doc-gradle-plugin 插件了。喜欢的用户请前往 smart-doc 项目查看插件的用户。最后也谢谢过去用户的支持。