Springboot整合springfox3+knife4j，生成接口文档

Posted 2023-03-18

参考技术A

在这篇博客中，会记录 springfox3 的基本配置与使用；由于swagger-ui看得不是很习惯，额外引入了 knife4j ，使用增强版本的swagger的前端ui。

注意
@ConditionalOnProperty 注解声明了当 springfox.documentation.enabled 为 true 时启用配置，而且默认值就是 true （Swagger仅仅建议在开发阶段使用）；

这里以 WebMvcConfig 为例。

@ApiImplicitParam
用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）--> 请求参数的获取：@PathVariable
· body（不常用）
· form（不常用）
dataType：参数类型，默认String，其它值dataType="Integer"
defaultValue：参数的默认值

swagger页面：项目地址 + /swagger-ui/index.html
knife4j页面：项目地址 + /doc.html

1. swagger3中，设置全局参数不生效