开发辅助

OpenAPI 差异与破坏性变更检查器

比较两个 OpenAPI 3 JSON 或 YAML 文档,报告路径、参数、响应和 schema 变更,并标记破坏性更新。

免费使用 无需注册 浏览器本地运行

工具操作区

5
总计
2
破坏性
3
非破坏性
3
新增
0
移除
2
变更
破坏性变更 Schemacomponents.schemas.Pet

移除的属性: name; 新增的必填属性: species; 新变为必填: species

破坏性变更 参数GET /pets parameter query:limit

参数变为必填。

非破坏性新增 路径/owners

新增了路径。

非破坏性新增 方法GET /owners

新增了操作。

非破坏性新增 响应GET /pets response 404

新增了响应。

什么是 OpenAPI 差异工具?

OpenAPI 差异工具按 API 契约结构比较两个版本,而不是进行普通文本对比。它会报告新增、删除和修改的路径、HTTP 方法、参数、响应及组件 schema,并识别可能破坏现有客户端的兼容性风险。

如何比较 OpenAPI 文档

  1. 1在左侧粘贴原始 OpenAPI 3 文档。
  2. 2在右侧粘贴更新后的 JSON 或 YAML 文档。
  3. 3查看变更总数和破坏性变更数量。
  4. 4在发布或升级 API 版本前逐项检查结果。

常见 API 契约检查

发布审查

部署前发现已删除操作、新增必填参数和不兼容 schema。

API 版本管理

判断契约更新是否需要主版本升级或迁移指南。

消费者协作

为 SDK 和集成负责人生成清晰的变更清单。

常见问题

支持哪些 OpenAPI 版本?

解析器支持 JSON 或 YAML 格式的 OpenAPI 3.x 文档。

哪些变更会标记为破坏性?

包括删除路径、方法、响应或 schema,新增必填参数或属性,以及修改参数或属性类型。

会解析外部 $ref 吗?

不会。比较在本地按文档结构进行;如需比较外部引用内容,请先将规范打包为单个文档。