SpringBoot 整合 Swagger3.0 和 Knife4j
作者:互联网
一、简介
Knife4j
的前身是swagger-bootstrap-ui,
取名knife4j是希望她能像一把匕首一样小巧,轻量,并且功能强悍,更名也是希望把她做成一个为Swagger接口文档服务的通用性解决方案,不仅仅只是专注于前端Ui前端。
二、pom.xml
<!-- knife4j 3.0.2 相关依赖 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
三、配置文件
@Configuration
@EnableSwagger2 //开启 Swagger2
@EnableOpenApi //开启 Swagger3,可以不写
@EnableKnife4j //开启 knife4j,可以不写
public class Knife4jConfiguration {
@Bean(value = "defaultApi3")
public Docket defaultApi3() {
// Swagger 2 使用的是:DocumentationType.SWAGGER_2
// Swagger 3 使用的是:DocumentationType.OAS_30
Docket docket = new Docket(DocumentationType.SWAGGER_2)
// 定义是否开启swagger,false为关闭,可以通过变量控制
.enable(true)
.apiInfo(new ApiInfoBuilder()
.title("XXX服务平台Api接口文档")
.description("XXX服务平台Api接口文档")
.termsOfServiceUrl("http://127.0.0.1:8080/login")
.contact(new Contact("作者", "地址", "邮箱或联系方式"))
.version("1.0")
.build())
//分组名称
.groupName("XXX服务平台")
.select()
.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
//这里指定Controller扫描包路径
//.apis(RequestHandlerSelectors.basePackage("com.chy.**.controller"))
.paths(PathSelectors.any())
.build();
return docket;
}
}
四、接口文档访问地址
knife4j 访问地址:http://localhost:8080/doc.html
Swagger2.0访问地址:http://localhost:8080/swagger-ui.html
Swagger3.0访问地址:http://localhost:8080/swagger-ui/index.html
标签:knife4j,http,SpringBoot,Swagger3.0,Knife4j,地址,文档,8080,swagger 来源: https://blog.csdn.net/Amber_1/article/details/121470338