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

有时候我们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

Guess you like

Origin blog.csdn.net/u010953880/article/details/115769378