【开发日记】Swagger添加全局Header参数

设置自定义的header参数,并要求使用人在测试接口时必须填写相应参数。

    @Bean
    public Docket docketBean() {
        //指定使用Swagger2规范
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        //描述字段支持Markdown语法
                        .description(this.applicationName+"的接口文档")
                        .contact(new Contact("二饭","https://gitee.com/StandFast","1786705138@qq.com"))
                        .version("1.0")
                        .build())
                .groupName(applicationName)
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.tworice")) // 指定接口扫描包路径
                .paths(PathSelectors.any())
                .build().globalRequestParameters(globalRequestParameters());
    }

    public List<RequestParameter> globalRequestParameters() {
        RequestParameter token = new RequestParameterBuilder()
                .name("token") // 设置header名称
                .in(ParameterType.HEADER) // 设置参数放在哪个地方,这里是header
                .required(true) // 设置是否必须传
                .build();
        RequestParameter adminID = new RequestParameterBuilder()
                .name("adminID") // 设置header名称
                .in(ParameterType.HEADER) // 设置参数放在哪个地方,这里是header
                .required(true) // 设置是否必须传
                .build();
        List<RequestParameter> parameters = new ArrayList<>();
        parameters.add(token);
        parameters.add(adminID);
        return parameters;
    }
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

二饭

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值