springboot 添加请求头（swagger）

桃扇骨 2023-07-17 11:27 78阅读 0赞

--------------------

### springboot 添加请求头（swagger） ###

**应用：使用swagger ui测试接口时，可添加header进行相关测试**

## ##

### \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* ###

**示例**

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**config 层**

**Swagger2Config**

@Configuration
    @EnableSwagger2
    public class Swagger2Config {
    
        @Bean
        public Docket initDocket(){
            List<Parameter> params=new ArrayList<>();
            Parameter header=new ParameterBuilder().name("header_name").description("请求头")
                    .modelRef(new ModelRef("string")).parameterType("header")
                    .required(false).defaultValue("gtlx").build();
            params.add(header);
    
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(initApiInfo())
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                    .paths(PathSelectors.any())
                    .build()
                    .globalOperationParameters(params);
        }
    
        private ApiInfo initApiInfo(){
            return new ApiInfoBuilder()
                    .title("构建 swagger2")
                    .description("接口测试")
                    .termsOfServiceUrl("http://www.baidu.com")
                    .version("v1.0")
                    .build();
        }
    }

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**controller 层**

**HelloController**

@RestController
    public class HelloController {
    
        @RequestMapping("/hello")
        public String hello(@RequestHeader("header_name") String value){
            System.out.println(value);
    
            return "hello world "+value;
        }
    }

### \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* ###

**使用测试**

**localhost:8080/swagger-ui.html**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70 1][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70 2][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70 3][]

**说明：header的值不能为中文，否则会报错 Failed to execute 'fetch' on 'Window': Value is not a valid ByteString.**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70]: /images/20230528/a22b5700233543e68e53d5f7191ace58.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70 1]: /images/20230528/e12d9d80cf3a4e73bac69138f708ebf0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70 2]: /images/20230528/4e648faefd814fc2ba87d89542c4b567.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70 3]: /images/20230528/b9d2f1f609d14ad0bb6a169e099d9700.png