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 vs Swagger

•  smart-doc不是对Swagger造轮子，这是一款用完全不同的理念重新开发的restful api接口文档生成工具。
•  smart-doc比swagger集成更简单，可以自由生成多种格式的api文档。
•  smart-doc完全不需要在侵入到业务代码中写任何注解。

更新内容

1.  增加对接口get方法的分析。
2.  增加对第三方jar中list泛型数据的解析。
3.  删除原来冗长的SourceBuilder代码。
4.  修改AdocDocBuilder、HtmlApiDocBuilder、ApiDocBuilder的方法名规范化，单元测试的升级需要做小部分变更。
5.  修改1.8.0重构后的请求示例将header放入普通参数的bug。
6.  修改参数加上@Validated注解后，文档里没有该参数信息的bug。
7.  新增@Deprecated标注接口的支持(使用line through完成样式标记)
8.  发布smart-doc-maven-plugin 1.0.2全面支持maven多模块项目。

maven插件

从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin，推荐使用最新版本的插件。

插件使用文档

升级建议

   本次主要是彻底解决了smart-doc-maven-plugin插件在maven项目中使用的各种问题，升级后的插件可以使用户不再需要写单元测试。新版插件也能为smart-doc赋能实现自动加载第三方组件发布的源代码解析生成文档。推荐使用最新版本插件(插件依赖最新版本smart-doc)。

DEMO

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

知名用户

• 科大讯飞
• 一加
• 小米

相关文档

smart-doc文档wiki