smart-doc 是一个 java restfulapi 文档生成工具，smart-doc 完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要写上 java 的标准注释，smart-doc 就能帮你生成一个简易明了的 Markdown、Html、AsciiDoc 文档和 Postman json 测试数据。smart-doc 的理念是让你的业务接口清爽整洁。不需要像 swagger 一样在接口中写一堆注解。

功能特性

• 零注解、零学习成本、只需要写标准 java 注释。
• 基于源代码接口定义自动推导，强大的返回结构推导。
• 支持 Spring MVC,Spring Boot,Spring Boot Web Flux(controller 书写方式)。
• 支持 Callable,Future,CompletableFuture 等异步接口返回的推导。
• 支持 JavaBean 上的 JSR303 参数校验规范。
• 对 json 请求参数的接口能够自动生成模拟 json 参数。
• 对一些常用字段定义能够生成有效的模拟值。
• 支持生成 json 返回值示例。
• 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的 jar 包)。
• 支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman json。
• 轻易实现在 Spring Boot 服务上在线查看静态 HTML5 api 文档。
• 开放文档数据，可自由实现接入文档管理系统。
• 一款代码注释检测工具，不写注释的小伙伴逃不过法眼了。

项目仓库

smart-doc 的码云仓库链接

github 仓库地址链接

更新内容

1. 修改 request 请求参数中嵌套对象不能解析的 bug，参考 gitee #I16AN2.
2. controller 参数是数组时添加 @PathVariable 注解会报空指针,参考 gitee #I16F6G
3. 新增 ApiDataBuilder 用于获取 smart-doc 生成的文档数据，包含 header、字典、错误码等。
4. 修改 github #9 文档错误 bug.
5. 新增接口的 @author 展示，方法从文档中查到找到接口负责人，生成文档可以选择关闭显示。
6. 重点：smart-doc 的 maven 插件 smart-doc-maven-plugin 1.0.0 版本发布。

smart-doc maven 插件

从 smart-doc 1.7.9 版本开始。我们提供了 smart-doc 的插件 smart-doc-maven-plugin。

[插件使用文档]( https://gitee.com/sunyurepository/smart-doc/wikis/smart-doc%20maven 插件?sort_id=1791450)

升级建议

本次推出了 smart-doc-maven-plugin 插件，更方便用户在 maven 项目中集成 smart-doc 生成文档，也方便在 maven 项目构建发布中直接使用 maven 命令生成项目文档。建议使用插件，通过引入插件方式，即便是不用 smart-doc 剔除了插件依赖也不会影响项目编译，对项目零影响。

DEMO

使用 demo 轻松玩转接口文档生成

相关文档

smart-doc 文档 wiki

smart-doc 的部分用户

排名不分先后

• 科大讯飞
• 小米
• 一加
• 北京远盟健康