swagger2 携带多个请求头

最新推荐文章于 2024-07-03 08:49:21 发布

SmileHan666

最新推荐文章于 2024-07-03 08:49:21 发布

阅读量3.9k

点赞数

CC 4.0 BY-SA版权

文章标签： swagger

本文链接：https://blog.youkuaiyun.com/aiguo94/article/details/99873920

本文介绍了如何在Swagger2中配置携带多个请求头，解决了可能出现的参数覆盖问题。通过示例代码和配置说明，展示了正确设置多个Header参数的方法，并提到了解决Swagger展示错误的解决方案。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

有看到网上文章说当header需要多个参数的时候，新建多个 ParameterBuilder，经过测试，重复使用一个ParameterBuilder会出现后面覆盖前面的情况。
我没有出现这种情况，以下是SwaggerConfig 的代码，以及效果图。

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Value("${swagger.enable:false}")
    private boolean enable=false;


    @Bean
    public Docket createRestApi() {
        //添加head参数配置start
        ParameterBuilder tokenPar1 = new ParameterBuilder();
        ParameterBuilder tokenPar2 = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        tokenPar1.name("token1")
                .description("请求头1")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(true)
                .build();
        tokenPar2.name("token2")
                .description("请求头2")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .build();
        pars.add(toke