OpenAPI 兼容性检查器

在本地比较两份 OpenAPI 3.x 规范,按接口和字段路径查看潜在的破坏性变更。

粘贴或选择旧版与新版 OpenAPI 3.0、3.1 或 3.2 文件。按风险级别查看受影响的接口和字段路径,再下载 Markdown 或 JSON 报告供复核。

发布前比较两份 OpenAPI 文件。规范内容仅在此浏览器中处理。

在下方粘贴 JSON 或 YAML,也可以选择文件。
在下方粘贴 JSON 或 YAML,也可以选择文件。

每个文件最多 2 MB、1,000 个接口操作。支持 OpenAPI 3.0、3.1 和 3.2。

使用说明

发布 API 前检查 OpenAPI 改动

在本地比较两份 OpenAPI 3.x 规范,按接口和字段路径查看潜在的破坏性变更。

操作步骤

  1. 通过以下入口提供原始输入:旧版规范 / 新版规范。
  2. 执行:检查兼容性。复制、下载或用于其他场景前,先检查结果。
  3. 粘贴或选择旧版与新版 OpenAPI 3.0、3.1 或 3.2 文件。按风险级别查看受影响的接口和字段路径,再下载 Markdown 或 JSON 报告供复核。

参数怎么选

选项取舍与影响
旧版规范工具会跟进规范文件内部的引用,不会访问外部文件或网址,并会将这些引用列为待复核项。递归 Schema 只比较首次遇到的结构,并提示人工复核。
检查兼容性工具会比较接口操作、参数、请求体、响应状态码和媒体类型,以及常见 Schema 变化,例如字段删除、请求字段变为必填、类型或枚举值变化。结果会列出受影响的接口和字段路径。

示例与预期结果

如果新版 GET /users/{id} 把原本可选的 `email` 响应字段改成必填,报告会指出契约变化。本地 `$ref` 会跟进;外部引用和复杂组合 Schema 会提示人工复核。本工具不是完整规范校验器,也不会测试正在运行的 API。

失败后怎么办

  • 这是静态接口契约复核,不是完整的 OpenAPI 合规校验、运行时 API 测试或安全审计。服务端行为、授权逻辑和复杂 Schema 组合可能需要人工检查。报告会注明未完整检查的引用或递归结构。
  • 解析失败时,先检查 JSON 或 YAML 语法,再看接口检查结果。把需要的本地引用放在同一文档;未解析的外部引用和不支持的结构需人工审核,工具不会抓取引用或测试在线服务器。

会检查哪些改动?

工具会比较接口操作、参数、请求体、响应状态码和媒体类型,以及常见 Schema 变化,例如字段删除、请求字段变为必填、类型或枚举值变化。结果会列出受影响的接口和字段路径。

如何处理引用?

工具会跟进规范文件内部的引用,不会访问外部文件或网址,并会将这些引用列为待复核项。递归 Schema 只比较首次遇到的结构,并提示人工复核。

哪些情况不在检查范围内?

这是静态接口契约复核,不是完整的 OpenAPI 合规校验、运行时 API 测试或安全审计。服务端行为、授权逻辑和复杂 Schema 组合可能需要人工检查。报告会注明未完整检查的引用或递归结构。