knife4j
是Swagger
的增强版,更契合微服务架构,ui
前身是Swagger-bootstrap-ui
,api
注解的使用方式和Swagger
一致。
1、引入依赖
<!--整合Knife4j-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.3</version>
</dependency>
<!--如果SpringBoot版本大于2.3则需要引入下面依赖-->
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
2、配置类
添加 @EnableKnife4j
注解。
@Configuration
@EnableOpenApi
@EnableKnife4j
public class Swagger3Config {
@Bean
public Docket webApiConfig(){
return new Docket(DocumentationType.OAS_30)
.groupName("webApi")
.apiInfo(webApiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.xxich"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo webApiInfo(){
return new ApiInfoBuilder()
.title("非遗项目 API 文档")
.description("本文档描述了非遗各个微服务接口定义")
.version("1.0")
.contact(new Contact("yanghui", "http://yanghui.com",
"[email protected]"))
.build();
}
}
3、进行测试
访问地址为:http://ip:port/doc.html