契约测试

契约测试用于验证实际 API 响应是否符合 API 文档（OpenAPI）中定义的规范。通过对状态码和响应结构等内容进行一致性检查，可以在开发、调试和测试阶段及时发现实现与文档之间的不一致，确保服务之间的 API 行为稳定可靠。

Apidog 的响应校验（契约测试）能力与 API 文档深度集成。它可用于 API 请求、调试用例、测试用例 和 自动化测试步骤 中。这是一项默认启用的基础功能。

启用响应校验

响应校验可以按模块启用，并根据业务需求在不同阶段使用。相关开关位于 “设置 -> 响应校验设置”。

启用后，“校验响应”功能可在 APIs 模块中的“请求”和“调试用例”视图中使用，用于在调试阶段验证响应一致性。

启用后，可以在 APIs 模块中的 “测试用例” 中执行“校验响应”，用于在手动测试期间验证 API 行为。

启用后，“校验响应”可以作为 测试步骤 添加到 Tests 模块中，将响应校验纳入完整的自动化测试流程。

Apidog 的响应校验会基于 API 文档中定义的 OpenAPI 规范自动执行以下检查：

检查实际响应的 HTTP 状态码是否与文档中定义的状态码一致。例如：

文档定义为 200，但实际返回为 204

文档定义了多个可能值（例如 200、201、400、403），则在允许范围内进行校验

如果不一致，将报告校验失败。

基于文档中定义的数据 Schema 校验以下内容：

字段是否为必填

字段值是否为 null

字段类型是否正确

必填字段是否存在

数组和对象的结构是否符合文档

枚举值是否有效

...

这是响应校验的核心能力。

对于 Object 类型字段：

如果文档中未设置 additionalProperties，你可以选择是否允许实际响应包含文档中未定义的额外字段。

如果设置了 additionalProperties，则根据文档规则校验是否允许额外字段。

此能力允许对响应结构进行宽松或严格控制，以适应不同团队的 API 约束要求。