最近项目使用了springboot,swagger2特此记录下使用过程
swagger2配置
@Configuration
public class Swagger {
@Value("${app.key}")
private String appKey;
@Bean
public Docket restApi() {
//添加head参数start
ParameterBuilder tokenPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<>();
tokenPar.name("authenticate")
.description("令牌")
.modelRef(new ModelRef("string"))
.parameterType("header")
.defaultValue(appKey)
.required(true).build();
pars.add(tokenPar.build());
return new Docket(DocumentationType.SWAGGER_2)
.globalOperationParameters(pars)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage(""))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("API")
.description("")
.contact(new Contact("H","127.0.0.1",""))
.version("1.0.0")
.build();
}
}
如果项目中有拦截器,则在配置拦截器时需要将swagger2的访问路径排除。
@Configuration
public class WebMvcConfig implements WebMvcConfigurer{
@Resource
private TokenInterceptor tokenInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
List<String> excludePathPatterns = new ArrayList<>();
excludePathPatterns.add("/swagger-ui.html");
excludePathPatterns.add("/swagger-resources/**");
excludePathPatterns.add("/webjars/**");
registry.addInterceptor(tokenInterceptor)
.addPathPatterns("/**")
.excludePathPatterns(excludePathPatterns)
.excludePathPatterns("/login");
}
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")
.allowedOrigins("*")
.allowedMethods("POST", "GET", "PUT", "OPTIONS", "DELETE")
.maxAge(3600)
.allowCredentials(true);
}