Elysia Tools
导航
Development
对比两份 OpenAPI 3.x schema，识别 breaking changes 并给出影响评级与迁移建议
详情
适合 API 团队在发版前识别高风险变更，如删除字段、收紧类型、请求体变必填等。
执行
填写表单、运行工具，并在同一页面查看结果。
案例
相关内容
等待运行
工具使用指南
API 破坏性变更检测与迁移规划器是一款专为研发团队设计的 OpenAPI 3.x 差异对比工具。通过输入新旧两份 Schema 文档，它能精准识别出删除字段、类型收紧、新增必填项等可能导致旧版客户端崩溃的高风险变更（Breaking Changes）。工具不仅会输出直观的差异对比，还会自动生成影响评级与具体的迁移建议，帮助团队在 API 发版前规避兼容性风险，保障上下游服务的平稳过渡。
背景
团队在重构用户创建接口时，为了数据完整性，决定强制要求客户端传入角色信息。
问题
需要确认将 requestBody 改为必填，并在其中新增必填字段 role 会对旧版客户端造成什么影响。
如何使用
将旧版 `/users` 接口的 Schema 填入旧版输入框，将包含 `required: true` 和 `required: [name, role]` 的新版 Schema 填入新版输入框并执行对比。
结果
工具检测到 requestBody 从非必填变为必填，且新增了必填字段 role，将其标记为高风险破坏性变更，并建议在当前版本保持非必填，在下一个大版本再强制要求。
背景
某微服务接口在优化响应体积时，移除了部分被认为“不再使用”的冗余字段。
问题
担心下游某些老旧系统仍在依赖这些被删除的字段，导致解析报错或业务逻辑异常。
如何使用
粘贴新旧两份 OpenAPI 文档进行对比，重点关注 responses 对象的差异报告。
结果
报告清晰列出 200 响应体中 name 字段被移除，提示此为严重破坏性变更，建议先使用 `@deprecated` 标记该字段而非直接删除。
目前主要支持 OpenAPI 3.x（包括 3.0 和 3.1）版本的 YAML 或 JSON 格式文档对比。
指可能导致现有客户端请求失败或解析错误的变更，例如删除已有响应字段、更改字段数据类型、或将非必填请求参数改为必填。
新增非必填字段通常属于向后兼容的安全变更。工具在对比时会将其识别为新增项，但不会将其标记为破坏性变更，从而让您聚焦于高风险项。
评级基于变更对客户端的破坏程度。例如，删除核心响应字段或新增必填请求参数为高风险；而修改字段描述或增加可选参数则为低风险或无风险。
不会。所有的 Schema 解析和对比处理均在安全的临时环境中完成，不会持久化存储您的 API 文档数据。