什么是 OpenAPI 差异工具?
OpenAPI 差异工具按 API 契约结构比较两个版本,而不是进行普通文本对比。它会报告新增、删除和修改的路径、HTTP 方法、参数、响应及组件 schema,并识别可能破坏现有客户端的兼容性风险。
如何比较 OpenAPI 文档
- 1在左侧粘贴原始 OpenAPI 3 文档。
- 2在右侧粘贴更新后的 JSON 或 YAML 文档。
- 3查看变更总数和破坏性变更数量。
- 4在发布或升级 API 版本前逐项检查结果。
常见 API 契约检查
发布审查
部署前发现已删除操作、新增必填参数和不兼容 schema。
API 版本管理
判断契约更新是否需要主版本升级或迁移指南。
消费者协作
为 SDK 和集成负责人生成清晰的变更清单。
常见问题
支持哪些 OpenAPI 版本?
解析器支持 JSON 或 YAML 格式的 OpenAPI 3.x 文档。
哪些变更会标记为破坏性?
包括删除路径、方法、响应或 schema,新增必填参数或属性,以及修改参数或属性类型。
会解析外部 $ref 吗?
不会。比较在本地按文档结构进行;如需比较外部引用内容,请先将规范打包为单个文档。