smart-doc 是一个 java restful api 文档生成工具，smart-doc 完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要写上 java 的标准注释，smart-doc 就能帮你生成一个简易明了的 Markdown、Html、AsciiDoc 文档和 Postman collection 一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染，smart-doc 给你一个不错的选择！喜欢 smart-doc 的用户也不要忘记给项目 star，你们的支持是 smart-doc 持续推进的动力。
功能特性
- 零注解、零学习成本、只需要写标准 java 注释。
- 基于源代码接口定义自动推导，强大的返回结构推导。
- 支持 Spring MVC,Spring Boot,Spring Boot Web Flux(controller 书写方式)。
- 支持 Callable,Future,CompletableFuture 等异步接口返回的推导。
- 支持 JavaBean 上的 JSR303 参数校验规范。
- 对 json 请求参数的接口能够自动生成模拟 json 参数。
- 对一些常用字段定义能够生成有效的模拟值。
- 支持生成 json 返回值示例。
- 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的 jar 包)。
- 支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman collection。
- 轻易实现在 Spring Boot 服务上在线查看静态 HTML5 api 文档。
- 开放文档数据，可自由实现接入文档管理系统。
- 一款代码注释检测工具，不写注释的小伙伴逃不过法眼了。
- 集成 smart-doc-maven-plugin 插件实现第三方依赖库源码自动加载
项目仓库
smart-doc 的码云仓库链接
github 仓库地址链接
更新内容
- 增加对接口 get 方法的分析。
- 增加对第三方 jar 中 list 泛型数据的解析。
- 删除原来冗长的 SourceBuilder 代码。
- 修改 AdocDocBuilder、HtmlApiDocBuilder、ApiDocBuilder 的方法名规范化，单元测试的升级需要做小部分变更。
- 修改 1.8.0 重构后的请求示例将 header 放入普通参数的 bug。
- 修改参数加上 @Validated 注解后，文档里没有该参数信息的 bug。
- 新增 @Deprecated 标注接口的支持(使用 line through 完成样式标记)
- 发布 smart-doc-maven-plugin 1.0.2 全面支持 maven 多模块项目。
升级建议
本次主要是彻底解决了 smart-doc-maven-plugin 插件在 maven 项目中使用的各种问题，升级后的插件可以使用户不再需要写单元测试。新版插件也能为 smart-doc 赋能实现自动加载第三方组件发布的源代码解析生成文档。推荐使用最新版本插件(插件依赖最新版本 smart-doc)。
DEMO
使用 demo 轻松玩转接口文档生成
相关文档
smart-doc 文档 wiki
smart-doc 的部分用户
排名不分先后