Swagger2 添加请求头参数

最新推荐文章于 2025-06-16 16:13:01 发布

斌小哥

最新推荐文章于 2025-06-16 16:13:01 发布

阅读量1.8w

点赞数 4

CC 4.0 BY-SA版权

分类专栏： Spring Boot 文章标签： Swagger

本文链接：https://blog.youkuaiyun.com/weixin_38319645/article/details/88627321

Spring Boot 专栏收录该内容

10 篇文章

订阅专栏

在局域网开发中，Swagger使用方便。但项目异地开发，通过Nginx设置反向代理后，需将swagger的host域名设为外网地址，还可能用请求头参数识别信息。介绍了设置host域名和添加请求头参数的方法，以及在配置文件中的设置。

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

使用Swagger在局域网的开发中是非常方便的，但如果项目需要异地进行开发的话，比如通过Nginx设置反向代理后，那么swagger的host域名需要设置成外网地址，而且有时会通过请求头的参数来识别某些信息。

1、host域名设置比较简单，只需要在swagger配置文件中设置host();

2、添加请求头参数的话，通过 globalOperationParameters()方法将请求头参数添加进去。

在bootstrap.properties中设置域名为 swagger.host的值

spring.application.name=datacenter
spring.profiles.active=dev
swagger.host=xxx.xxx.xxx:8080

swagger配置文件如下:

@Configuration
@EnableSwagger2
@PropertySource(value = "classpath:bootstrap.properties" ,ignoreResourceNotFound=true)
public class SwaggerConfig {

    @Value("${swagger.host}")
    private String host;

    @Bean
    public Docket api() {

        //添加head参数start
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        tokenPar.name("real_source_ip").description("本机局域网IP").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .host(host)
                .select()
                .apis(RequestHandlerSelectors.
                        basePackage("com"))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars);
    }
}

swagger-ui.html效果如下: