SpringBoot接口 - 如何生成接口文档之非侵入方式（通过注释生成）Smart-Doc？

通过Swagger系列可以快速生成API文档，但是这种API文档生成是需要在接口上添加注解等，这表明这是一种侵入式方式； 那么有没有非侵入式方式呢, 比如通过注释生成文档？ 本文主要介绍非侵入式的方式及集成Smart-doc案例。我们构建知识体系时使用Smart-doc这类工具并不是目标，而是 要了解非侵入方式能做到什么程度和技术思路 。 @pdai

• SpringBoot接口 - 如何生成接口文档之非侵入方式（通过注释生成）Smart-Doc？

准备知识点

需要了解Swagger侵入性和依赖性， 以及Smart-Doc这类工具如何解决这些问题, 部分内容来自官方网站。@pdai

为什么会产生Smart-Doc这类工具？

既然有了Swagger， 为何还会产生Smart-Doc这类工具呢？ 本质上是Swagger侵入性和依赖性。

我们来看下目前主流的技术文档工具存在什么问题：

1. 侵入性强 ，需要编写大量注解，代表工具如：swagger，还有一些公司自研的文档工具
2. 强依赖性 ，如果项目不想使用该工具，业务代码无法编译通过。
3. 代码解析能力弱，使用文档不齐全，主要代表为国内众多开源的相关工具。
4. 众多基于注释分析的工具无法解析jar包里面的注释(sources jar包)，需要人工配置源码路径，无法满足DevOps构建场景。
5. 部分工具无法支持多模块复杂项目代码分析。

什么是Smart-Doc？有哪些特性？

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、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。 Up- 开放文档数据，可自由实现接入文档管理系统。
• 支持导出错误码和定义在代码中的各种字典码到接口文档。
• 支持Maven、Gradle插件式轻松集成。
• 支持Apache Dubbo RPC接口文档生成。
• debug接口调试html5页面完全支持文件上传，下载(@download tag标记下载方法)测试。

实现案例

从smart-doc 1.7.9开始官方提供了Maven插件，可以通过在项目中集成smart-doc的Maven插件，然后运行插件直接生成文档。 我们的案例基于smart-doc-maven-plugin，生成文档。示例参考官方配置文档而写。

配置

添加maven的插件

    
        
            org.springframework.boot
            spring-boot-maven-plugin
        
        
            com.github.shalousun
            smart-doc-maven-plugin
            2.4.8
            
                
                ./src/main/resources/smart-doc.json
                
                
                
                
                
                    
                    
                    com.alibaba:fastjson
                
                
                
                
                    
                    
                    com.alibaba:fastjson
                
            
            
                
                    
                    compile