[开发] swagger-ui页面设置接口请求头head参数

swagger-ui页面设置接口请求头head参数

2023-06-20 10:10:44 星期二
文章来源：https://blog.csdn.net/u010953880/article/details/115769378
目前状态：有效
适用系统：
开源情况：开源

---

有时候我们http请求需要设置请求头信息，
那么当我们用swagger调试接口的时候怎么传head参数呢？

有两种方式：

1. 设置全局的请求头，对所有接口都适用

在swagger配置类中增加：

点击查看代码

@Bean
    public Docket createRestApi() {
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar.name("accessToken").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());

        ApiSelectorBuilder builder = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.XXX"))
                .paths(PathSelectors.any());

        return builder.build().globalOperationParameters(pars);
    }

2：针对单个接口，设置请求头：

@ApiImplicitParam(name = "accessToken", required = false,paramType = "header",dataType = "String")
在接口上增加该注解即可
哪个接口需要请求头，就加此代码即可

@ApiImplicitParams注解的常见用法：
https://blog.csdn.net/jiangyu1013/article/details/83107255