引入swagger包:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger2.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger2.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-spring-webmvc</artifactId>
<version>${swagger2.version}</version>
</dependency>
版本:
<swagger2.version>2.10.5</swagger2.version>
Swagger2全局配置:
@Configuration
@EnableSwagger2WebMvc
public class Swagger2Config {
/**
* @return
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.enable(!"prod".equals(active))
.select()
.apis(RequestHandlerSelectors.basePackage(basePackage))
.paths(PathSelectors.any())
.build()
.globalOperationParameters(setHeaderToken());
}
// TODO 测试token值,上线关闭
String testTokenValue = "";
ParameterBuilder tokenPar = new ParameterBuilder();
Parameter tokenParameter = tokenPar
.name("nsid")
.description("sessionId, 丝袜哥debug专用")
.modelRef(new ModelRef("string"))
.parameterType("header")
.required(false)
.defaultValue(testTokenValue)
.build();
pars.add(tokenParameter);
return pars;
}
}
具体讲解参见文章swagger-ui升级到2.10.5版本问题