介绍

smart-doc是一款同时支持 java REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念， 完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照 JAVA -doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、 html5 、Postman Collection2.0+、OpenAPI 3.0+的文档。

特点

• 零注解、零学习成本、只需要写标准JAVA注释。
• 基于源代码接口定义自动推导，强大的返回结构推导。
• 支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign。
• 支持Callable、Future、CompletableFuture等异步接口返回的推导。
• 支持 JavaBean 上的JSR303参数校验规范，包括分组验证。
• 对JSON请求参数的接口能够自动生成模拟JSON参数。
• 对一些常用字段定义能够生成有效的模拟值。
• 支持生成JSON返回值示例。
• 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
• 支持生成多种格式文档：Markdown、 html 5、Asciidoctor、Postman Collection、OpenAPI 3.0。 Up- 开放文档数据，可自由实现接入 文档管理系统 。
• 支持导出错误码和定义在代码中的各种字典码到接口文档。
• 支持Maven、 gradle 插件式轻松集成。
• 支持Apache Dubbo RPC接口文档生成。
• debug接口调试html5页面完全支持文件上传，下载(@download tag标记下载方法)测试。

maven使用

一、添加smart-doc依赖

因为smart-doc-maven-plugin最终是使用smart-doc来完成项目的源码分析和文档生成的，通常情况下真正的调试的代码是smart-doc。但这个过程主要通过smart-doc- maven -plugin来排查。

 <dependency>
     <groupId>com.github.shalousun</groupId>
     <artifactId>smart-doc</artifactId>
     <version>[最新版本]</version>
     <scope>test</scope>
</dependency>
  

二、 在idea中maven项目中生成文档

Gradle 使用

一、添加smart-doc依赖

添加smart-doc依赖主要是方便直接查看到源码调试。未发生错误，不需要调试事并不需要在自己的项目中添加smart-doc依赖。

 dependencies {
    testCompile 'com.github.shalousun:smart-doc:【最新版本】'
}
  

二、idea中gradle项目中生成文档

生成文档效图 一、接口文档效果图

二、html全局效果