springboot配置swagger2

          最近项目使用了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);
}
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值