@RequestHeader Map<String,String>在Swagger UI中无法使用的问题咨询

Swagger默认不会为Map<String, String>类型的@RequestHeader参数生成输入区域，因为它无法自动识别Map中的动态键值对。以下是两种可行的解决方式：

方案一：利用Swagger注解生成可重复的请求头输入项 #

这是最符合HTTP规范的方案，能让用户在Swagger UI中自由添加任意数量的自定义请求头，所有输入的键值对都会自动映射到Map参数中。

只需在控制器方法上添加@ApiImplicitParams和@ApiImplicitParam注解，配置允许重复添加的请求头参数：

@GetMapping("/object")
@ApiImplicitParams({
    @ApiImplicitParam(
        name = "自定义请求头",
        paramType = "header",
        dataTypeClass = String.class,
        allowMultiple = true,
        value = "可添加任意数量的自定义请求头，输入框左侧填键名，右侧填对应值"
    )
})
public ResponseEntity<MyObject> getObject(
        @RequestHeader String test,
        @RequestHeader Map<String, String> headers) {
    // 业务逻辑处理
    return ResponseEntity.ok(new MyObject());
}

配置后，Swagger UI会显示一个可多次点击"Add item"的输入区域，用户每添加一次就能输入一组请求头的键和值，这些内容会被自动收集到headers Map中。

方案二：通过JSON文本框传递自定义请求头（特殊场景适用） #

如果需要类似@RequestBody的文本框输入体验，可以让用户输入JSON格式的键值对，后端再解析为Map。但这种方式不符合常规请求头的使用方式，仅适合特定需求场景：

1. 定义接收JSON字符串的请求头参数：

@GetMapping("/object")
@ApiImplicitParams({
    @ApiImplicitParam(
        name = "X-Custom-Headers",
        paramType = "header",
        dataTypeClass = String.class,
        value = "输入JSON格式的请求头键值对，示例：{\"key1\":\"value1\",\"key2\":\"value2\"}"
    )
})
public ResponseEntity<MyObject> getObject(
        @RequestHeader String test,
        @RequestHeader("X-Custom-Headers") String customHeaders) throws JsonProcessingException {
    // 将JSON字符串解析为Map
    ObjectMapper objectMapper = new ObjectMapper();
    Map<String, String> headers = objectMapper.readValue(customHeaders, new TypeReference<>() {});
    
    // 业务逻辑处理
    return ResponseEntity.ok(new MyObject());
}

用户需要在Swagger UI的X-Custom-Headers输入框中填写JSON格式的键值对，后端再将其解析为Map使用。

总结 #

优先选择方案一，它既符合HTTP请求头的使用规范，又能满足自由添加多个请求头的需求，Swagger UI的交互体验也更直观。

内容的提问来源于stack exchange，提问作者MrCoder