SpringBoot 集成Swagger3+knife4j

以下代码来自本人真实企业项目摘录

1. 导入SpringFox依赖

<!--Swagger3相关-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>

springfox依赖中整合了Swagger3等有关依赖，引入该依赖之前请删除引入的Swagger相关依赖

2. 编写Swagger配置

package me.zhengjie.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestParameterBuilder;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import java.util.ArrayList;
import java.util.List;
/**
* Description: Swagger3+knife4j Config
*
* @author: ZhuMaoqiang
* @date: 2022-03-18
*/
@EnableOpenApi // 开启Swagger3
@Configuration
@Import(BeanValidatorPluginsConfiguration.class)
public class Swagger3Config {
@Bean(value = "defaultApi")
public Docket defaultApi() {
Docket docket = new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
//分组名称
.groupName("默认分组")
.select()
// 扫描所有Controller
.paths(PathSelectors.any())
.build()
.securitySchemes(securitySchemes())
.securityContexts(securityContexts());
return docket;
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("接口文档")
.description("接口文档 RESTful APIs")
.contact(new Contact("朱茂强", "", "896228072@qq.com"))
.version("1.0")
.build();
}
/**
* Swagger 非全局Head参数（Token）配置
*/
private List<SecurityScheme> securitySchemes() {
List<SecurityScheme> securitySchemes = new ArrayList<>();
securitySchemes.add(new ApiKey("Authorization", "Authorization", "header"));
return securitySchemes;
}
/**
* 授权信息全局应用
*/
private List<SecurityContext> securityContexts() {
List<SecurityContext> securityContexts = new ArrayList<>();
securityContexts.add(SecurityContext.builder()
.securityReferences(defaultAuth())
.forPaths(PathSelectors.any()).build());
return securityContexts;
}
/**
* Swagger 全局、无需重复输入的Head参数（Token）配置
*/
private List<SecurityReference> defaultAuth() {
AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
authorizationScopes[0] = authorizationScope;
List<SecurityReference> securityReferences = new ArrayList<>();
securityReferences.add(new SecurityReference("Authorization", authorizationScopes));
return securityReferences;
}
}

配置到此就可以使用：http://ip:端口//swagger-ui/index.html 进行访问接口文档了。

3. 引入knife4j依赖，swagger的升级版

<!--knife4j-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>

在配置完Swagger后引入此依赖就可以使用 http://ip:端口/doc.html访问接口文档。

有关knife4j的更多配置请查询官方文档：knife4j (xiaominfo.com)

最后

以上就是感动早晨为你收集整理的SpringBoot 集成Swagger3+knife4jSpringBoot 集成Swagger3+knife4j的全部内容，希望文章能够帮你解决SpringBoot 集成Swagger3+knife4jSpringBoot 集成Swagger3+knife4j所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。