maven 依赖
<!-- swagger start -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
<!-- swagger end -->
package com.ct.wms.core.swagger;
import com.ct.wms.core.util.JwtTokenUtil;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
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.builders.RequestParameterBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ParameterType;
import springfox.documentation.service.RequestParameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.List;
/**
* title: SwaggerConfig
* description: swagger配置
*
*/
@Configuration
@EnableSwagger2
@ConditionalOnWebApplication
public class SwaggerConfig {
/**
* 标题
*/
@Value("${swagger.title}")
private String title;
/**
* 基本包
*/
@Value("${swagger.base.package}")
private String basePackage;
/**
* 描述
*/
@Value("${swagger.description}")
private String description;
/**
* URL
*/
@Value("${swagger.url}")
private String url;
/**
* 版本
*/
@Value("${swagger.version}")
private String version;
/**
* 版本
*/
@Value("${swagger.enable}")
private boolean enable = false;
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.enable(enable)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(basePackage))
.paths(PathSelectors.any())
.build()
.globalRequestParameters(setHeaderToken())
;
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(title)
.description(description)
.termsOfServiceUrl(url)
.version(version)
.build();
}
/**
* 增加接口默认token参数,设置到header中
*
* @return
*/
private List<RequestParameter> setHeaderToken() {
List<RequestParameter> pars = new ArrayList<>();
// token请求头
RequestParameterBuilder tokenPar = new RequestParameterBuilder();
RequestParameter tokenParameter = tokenPar
.name(JwtTokenUtil.getTokenName())
.description("Token Request Header")
.name("token")
.parameterIndex(1)
.in(ParameterType.HEADER)
.required(false)
.build();
pars.add(tokenParameter);
return pars;
}
}