package com.xxx.config;
import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;
/**
* Description: </br>
* </br>
* ClassName: Knife4JConfig
* @version 1.0
* @since JDK 1.8
*/
@Configuration
@EnableKnife4j
@EnableSwagger2WebMvc
public class Knife4JConfig {
/**
* @param
* @return Docket
* @description knife4j配置类
* @author lixin
* @date 2021/5/6 13:54
*/
@Bean(value = "defaultApi2")
public Docket defaultApi2() {
Docket docket = new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
//分组名称
.groupName("API")
.select()
//这里指定Controller扫描包路径(项目路径也行)
.apis(RequestHandlerSelectors.basePackage("com.*"))
.paths(PathSelectors.any())
.build();
return docket;
}
/**
* @param
* @return ApiInfo
* @description 接口文档信息
* @author lixin
* @date 2021/5/6 13:55
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("xx在线API接口文档")
.description("xxAPI接口在线文档")
.version("2.0")
.build();
}
}
maven
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.8</version>
</dependency>