Elysia Tools
导航
Development
将真实 API 响应 JSON 与 OpenAPI 3.x 中声明的 response schema 对照校验
详情
粘贴 OpenAPI 3.x 文档和一个真实 API 响应，再指定 path、method 与 status code。工具会解析对应的 response schema，并高亮缺失字段、类型错误、枚举越界和未文档化字段。
使用说明：
执行
填写表单、运行工具，并在同一页面查看结果。
案例
相关内容
等待运行
工具使用指南
API 响应契约校验器是一款专为开发者设计的在线工具，能够将真实的 API 响应 JSON 与 OpenAPI 3.x 规范中声明的响应 Schema 进行对照校验。只需粘贴 OpenAPI 文档和实际的返回数据，并指定路径、请求方法与状态码，工具即可自动解析并高亮显示缺失字段、类型错误、枚举越界以及未文档化的额外字段，帮助您快速发现接口契约漂移问题，确保前后端数据交互的准确性与稳定性。
背景
后端重构了用户详情接口，需要确认重构后的实际返回数据是否依然符合原有的 OpenAPI 契约。
问题
手动比对 JSON 字段和 YAML 文档耗时且容易遗漏类型错误（如数字变成了字符串）。
如何使用
粘贴 OpenAPI YAML 规范和重构后的响应 JSON，指定路径 `/users/42`、方法 `GET` 和状态码 `200`，并勾选禁止额外字段。
Path: /users/42
Method: GET
Status Code: 200
Spec Format: YAML
Disallow Additional Properties: true结果
工具精准指出 `id` 应该是 integer 而非 string，`active` 应该是 boolean 而非 string，并提示缺少必填的 `name` 字段。
背景
在接入外部供应商的订单 API 时，发现系统解析日志中出现异常，怀疑对方返回了未文档化的数据。
问题
需要快速找出实际响应中哪些字段是 OpenAPI 文档中未声明的。
如何使用
将供应商提供的 OpenAPI JSON 和实际抓包得到的响应 JSON 填入工具，设置对应路径和 `POST` 方法，开启“禁止额外字段”选项。
Method: POST
Status Code: 201
Spec Format: Auto
Disallow Additional Properties: true结果
校验结果高亮显示了响应 JSON 中多出的未文档化字段，方便工程师与供应商沟通确认接口变更。
当前工具主要支持 OpenAPI 3.x 版本的规范文档，您可以粘贴 YAML 或 JSON 格式的规范内容。
您可以将规范格式（Spec Format）设置为“Auto”，工具会自动识别您粘贴的规范内容是 YAML 还是 JSON 格式。
勾选此选项后，如果实际响应 JSON 中包含了 OpenAPI Schema 中未声明的字段，工具会将其标记为警告或错误，帮助您发现未文档化的冗余数据。
一个 OpenAPI 文档通常包含多个接口和不同的响应状态。指定这些参数可以帮助工具精确定位到需要校验的具体 Response Schema 分支。
工具会根据 OpenAPI 规范中的 required 属性进行检查，如果实际响应中缺少这些必填字段，校验报告中会明确高亮提示缺失错误。