之前我在 SpringBoot 老鸟系列中专门花了大量的篇幅详细介绍如何集成 Swagger,以及如何对 Swagger 进行扩展让其支持接口参数分组功能。详情可见:SpringBoot 如何生成接口文档,老鸟们都这么玩的!
可是当我接触到另一个接口文档工具 smart-doc
后,我觉得它比 Swagger 更适合集成在项目中,更适合老鸟们。今天我们就来介绍一下 smart-doc 组件的使用,作为对老鸟系列文章的一个补充。
swagger vs smart-doc
首先我们先看一下 Swagger 组件目前存在的主要问题:
-
Swagger 的代码侵入性比较强
这个很容易理解,要让 Swagger 生成接口文档必须要给方法或字段添加对应的注解,是存在代码侵入的。
-
原生 swagger 不支持接口的参数分组
对于有做参数分组的接口,原生的 Swagger 并未支持,虽然我们通过扩展其组件可以让其支持参数分组,但是毕竟要开发,而且还未支持最新的 Swagger3 版本。
那作为对比,smart-doc
是基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释的写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。官方地址:https://gitee.com/smart-doc-team/smart-doc
简单罗列一下 smart-doc 的优点:
- 零注解、零学习成本、只需要写标准 java 注释即可生成文档。
- 基于源代码接口定义自动推导,强大的返回结构推导。
- 支持 Spring MVC,Spring Boot,Spring Boot Web Flux(controller 书写方式)。
- 支持 Callable,Future,CompletableFuture 等异步接口返回的推导。
- 支持 JavaBean 上的 JSR303 参数校验规范,支持参数分组。
- 对一些常用字段定义能够生成有效的模拟值。
- ...
接下来我们来看看 SpringBoot 中如何集成 smart-doc。
SpringBoot 集成 smart-doc
smart-doc 支持多种方式生成接口文档:maven 插件、gradle 插件、单元测试(不推荐),这里我才用的是基于 maven 插件生成,步骤如下:
- 引入依赖,版本选择最新版本
<!--引入smart-doc-->
<plugin>
<groupId>com.github.shalousun</groupId>
<artifactId>smart-doc-maven-plugin</artifactId>
<version>2.2.7</version>
<configuration>
<configFile>./src/main/resources/smart-doc.json</configFile>
<projectName>Smart-Doc初体验</projectName>
</configuration>
</plugin>
重点在 configFile
中指定 smart-doc 配置文件 smart-doc.json
- 新建配置文件 smart-doc.json
{
"outPath": "src/main/resources/static/doc"
}
指定 smart-doc 生成的文档路径,其他配置项可以参考官方 wiki。
- 通过执行 maven 命令生成对应的接口文档
//生成html
mvn -Dfile.encoding=UTF-8 smart-doc:html
当然也可以通过 idea 中的 maven 插件生成
4. 访问接口文档
生成接口文档后我们通过 http://localhost:8080/doc/api.html
查看,效果如下:
看到这里的同学可能会呵呵一笑,就这?啥也没有呀!这还想让我替换 Swagger?
别急,刚刚只是体验了 smart-doc 的基础功能,接下来我们通过丰富 smart-doc 的配置文件内容来增强其功能。
功能增强
1. 开启调试
一个优秀的接口文档工具调试功能必不能少,smart-doc 支持在线调试功能,只需要加入如下几个配置项:
{
"serverUrl": "http://localhost:8080", -- 服务器地址
"allInOne": true, -- 是否将文档合并到一个文件中,一般推荐为true
"outPath": "src/main/resources/static/doc", -- 指定文档的输出路径
"createDebugPage": true, -- 开启测试
"allInOneDocFileName":"index.html", -- 自定义文档名称
"projectName": "初识smart-doc" -- 项目名称
}
通过"createDebugPage": true 开启 debug 功能,在让生成 smart-doc 生成文档时直接放入到 static/doc/
下,这样可以直接启动程序访问页面 http://localhost:8080/doc/index.html
进行开发调试。
有的开发人员直接在 idea 中使用【Open In Browser】打开 smart-doc 生成的 debug 页面,如果非要这做,前端 js 请求后台接口时就出现了跨域。因此你需要在后端配置跨域。
这里以 SpringBoot2.3.x 为例配置后端跨域:
@Configuration
public class WebMvcAutoConfig implements WebMvcConfigurer {
@Bean
public CorsFilter corsFilter() {
final UrlBasedCorsConfigurationSource urlBasedCorsConfigurationSource = new UrlBasedCorsConfigurationSource();
final CorsConfiguration corsConfiguration = new CorsConfiguration();
/* 是否允许请求带有验证信息 */
corsConfiguration.setAllowCredentials(true);
/* 允许访问的客户端域名 */
corsConfiguration.addAllowedOrigin("*");
/* 允许服务端访问的客户端请求头 */
corsConfiguration.addAllowedHeader("*");
/* 允许访问的方法名,GET POST等 */
corsConfiguration.addAllowedMethod("*");
urlBasedCorsConfigurationSource.registerCorsConfiguration("/**", corsConfiguration);
return new CorsFilter(urlBasedCorsConfigurationSource);
}
}
开启跨域后我们就可以直接在静态接口页面中进行调试了。
2. 通用响应体
在 “SpringBoot 如何统一后端返回格式?老鸟们都是这样玩的!”一文中我们通过实现 ResponseBodyAdvice
对所有返回值进行了包装,给前端返回统一的数据结构 ResultData,我们需要让其在接口文档中也有此功能,在配置文件追加配置内容:
{
"responseBodyAdvice":{ -- 通用响应体
"className":"com.jianzh5.blog.base.ResultData"
}
}
3. 自定义 Header
在前后端分离项目中我们一般需要在请求接口时设置一个请求头,如 token,Authorization 等...后端根据请求头判断是否为系统合法用户,目前 smart-doc 也对其提供了支持。
在 smart-doc 配置文件 smart-doc.json
中继续追加如下配置内容:
"requestHeaders": [ //设置请求头,没有需求可以不设置
{
"name": "token",//请求头名称
"type": "string",//请求头类型
"desc": "自定义请求头 - token",//请求头描述信息
"value":"123456",//不设置默认null
"required": false,//是否必须
"since": "-",//什么版本添加的改请求头
"pathPatterns": "/smart/say",//只有以/smart/say 开头的url才会有此请求头
"excludePathPatterns":"/smart/add,/smart/edit" // url=/app/page/将不会有该请求头
}
]
效果如下:
4. 参数分组
演示一下 smart-doc 对于参数分组的支持
新增操作时,age、level 为必填项,sex 为非必填。
编辑操作时,id,appid,leven 为必填项,sex 为非必填。
通过上面的效果可以看出 smart-doc 对于参数分组是完全支持的。
5. idea 配置 doc
自定义的 tag 默认是不会自动提示的,需要用户在 idea 中进行设置。设置好后即可使用,下面以设置 smart-doc 自定义的 mock tag 为例,设置操作如下:
### 6. 完整配置
附上完整配置,如果还需要其他配置大家可以参考 wiki 自行引入。
{
"serverUrl": "http://localhost:8080",
"allInOne": true,
"outPath": "src/main/resources/static/doc",
"createDebugPage": true,
"allInOneDocFileName":"index.html",
"projectName": "初识smart-doc",
"packageFilters": "com.jianzh5.blog.smartdoc.*",
"errorCodeDictionaries": [{
"title": "title",
"enumClassName": "com.jianzh5.blog.base.ReturnCode",
"codeField": "code",
"descField": "message"
}],
"responseBodyAdvice":{
"className":"com.jianzh5.blog.base.ResultData"
},
"requestHeaders": [{
"name": "token",
"type": "string",
"desc": "自定义请求头 - token",
"value":"123456",
"required": false,
"since": "-",
"pathPatterns": "/smart/say",
"excludePathPatterns":"/smart/add,/smart/edit"
}]
}
小结
其实没什么可总结的,smart-doc 使用非常简单,官方文档也非常详细,只要你会写标准的 java 注释就可以给你生成详细的接口文档。(如果你说你不会写注释,那这篇文章可能不太适合你) 而且在引入 smart-doc 后还可以强制要求开发人员给接口编写注释,保证团队代码风格不会出现很大差异。
老鸟系列源码已经上传至 GitHub,需要的在公众号【JAVA 日知录】回复关键字 0923 获取
欢迎来到这里!
我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。
注册 关于