Dredd接口验证未通过：如何处理Header匹配问题？

- name: userId
              in: path
              description: desc
              required: true
              schema:
                  type: string
              example: "someID"
        responses:
            "200":
                description: desc
                content:
                    "application/json":
                        schema:
                            $ref: '#/components/schemas/DataModel'

components:
schemas:
DataModel:
type: object
properties:
data1:
type: integer
format: int32
data2:
type: integer
format: int32
data3:
type: integer
format: int32

执行测试后得到如下结果：
```bash
request: 
method: GET
uri: /users/<someID>/data
headers: 
    some-token: 389fe056-e904-48fd-8d89-caaf8769ab84
    ...
    User-Agent: Dredd/14.0.0 (Linux 5.10.104-linuxkit; x64)

body: 


expected: 
headers: 
    Content-Type: application/json; charset=utf-8

body: 
{
  "data1": 0,
  "data2": 0,
  "data3": 0
}
statusCode: 200


actual: 
statusCode: 200
headers: 
    server: Apache-Coyote/1.1
    set-cookie: rememberMe=deleteMe; Path=/somepath; Max-Age=0; Expires=Thu, 17-Nov-2022 08:41:46 GMT; Secure
    content-type: application/json;charset=UTF-8
    transfer-encoding: chunked
    date: Fri, 18 Nov 2022 08:41:46 GMT
    connection: close

bodyEncoding: utf-8
body: 
{
  "data1": 0,
  "data2": 0,
  "data3": 0
}

响应的Body与状态码完全匹配，但验证未通过，推测是Header相关问题。请问：

1. 如何让该测试通过验证？
2. Header匹配是否是测试通过的必要条件？若是，该如何实现Header匹配？

注：我知晓Stackoverflow上已有类似问题，但因提问时间较久，故重新提问补充细节。

Header匹配是否是测试通过的必要条件？ #

是的，默认情况下Dredd这类API测试工具会严格校验规范中明确定义的响应Header。但并非实际返回的所有Header都需要匹配——只有在OpenAPI里声明过的Header才会被强制校验，不过部分工具默认会检查是否存在未声明的额外Header，这也可能导致验证失败。

你的问题核心有两点：

• 实际返回的Content-Type值是application/json;charset=UTF-8，和预期的application/json; charset=utf-8存在大小写、空格差异，触发校验失败；
• 实际返回了规范中未定义的额外Header（如server、set-cookie），部分工具会因为这个判定不通过。

如何让测试通过验证？ #

方案1：调整OpenAPI规范，兼容实际返回值 #

直接修改200响应的Content-Type定义，和实际返回保持一致：

responses:
    "200":
        description: desc
        headers:
            Content-Type:
                schema:
                    type: string
                    example: "application/json;charset=UTF-8"
        content:
            "application/json":
                schema:
                    $ref: '#/components/schemas/DataModel'

或者放宽Content-Type的校验规则，用正则忽略大小写和空格差异：

responses:
    "200":
        description: desc
        headers:
            Content-Type:
                schema:
                    type: string
                    pattern: ^application/json;charset=.*utf-8.*$
        content:
            "application/json":
                schema:
                    $ref: '#/components/schemas/DataModel'

方案2：配置测试工具忽略无关Header或放宽校验 #

以你使用的Dredd为例：

• 忽略额外返回的Header：在dredd.yml配置文件中添加全局规则，关闭不必要的Header校验：

options:
  headerValidation: false

或者针对单个接口添加扩展，指定忽略的Header：

paths:
    /users/{userId}/data:
        get:
            x-dredd-ignore-headers: ['server', 'set-cookie', 'transfer-encoding', 'date', 'connection']
            # 保留原有其他配置...

• 放宽Content-Type大小写校验：使用Dredd钩子脚本，在校验前统一转换Header值的大小写：

// hooks.js
const hooks = require('hooks');

hooks.after('userData', (transaction) => {
  // 统一转换实际响应和预期的Content-Type为小写
  if (transaction.real.headers['content-type']) {
    transaction.real.headers['content-type'] = transaction.real.headers['content-type'].toLowerCase();
  }
  if (transaction.expected.headers['Content-Type']) {
    transaction.expected.headers['Content-Type'] = transaction.expected.headers['Content-Type'].toLowerCase();
  }
});

运行Dredd时指定钩子文件：

dredd openapi.yml http://your-api-endpoint --hooks=hooks.js

方案3：允许响应包含额外Header #

在OpenAPI规范的200响应中添加additionalProperties: true，明确允许返回规范外的Header：

responses:
    "200":
        description: desc
        headers:
            Content-Type:
                schema:
                    type: string
        additionalProperties: true
        content:
            "application/json":
                schema:
                    $ref: '#/components/schemas/DataModel'

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