配置Swagger带token访问

第一种:设置全局token

@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        //加了ApiOperation注解的类,才生成接口文档
        .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
        //包下的类,才生成接口文档
        //.apis(RequestHandlerSelectors.basePackage("io.sysssc.controller"))
        .paths(PathSelectors.any())
        .build()
        .securitySchemes(security());  //主要关注点--统一填写一次token
}
    
private List<ApiKey> security() {
    return newArrayList(
        new ApiKey("token", "token", "header")
    );
}

 上面两段代码主要都是在swagger的配置类SwaggerConfig(或者Swagger2Config)中,createRestApi()方法是原本配置类中就有的,主要就关注最后一个引用的方法即可。security()方法中token是可以自己定义的。

第二种:接口单独传token

@Bean
public Docket createRestApi() {
       return new Docket(DocumentationType.SWAGGER_2)
           .apiInfo(apiInfo())
           .select()
           //加了ApiOperation注解的类,才生成接口文档
           .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
           //包下的类,才生成接口文档
           //.apis(RequestHandlerSelectors.basePackage("io.sysssc.controller"))
           .paths(PathSelectors.any())
           .build()
           .globalOperationParameters(globalOperation());       // 主要关注点----每个接口调用都填写token
}

private List<Parameter> globalOperation(){
        //添加head参数配置start
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        //第一个token为传参的key,第二个token为swagger页面显示的值
        tokenPar.name("token").description("token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());

        return pars;
}

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值