OpenAPI Diff是如何实现识别breaking change的
时间: 2024-02-19 22:00:54 浏览: 64
openapi-diff:库和CLI比较两个OpenAPI Specification v3文件
OpenAPI Diff 是一个开源工具,用于比较两个 OpenAPI 规范(或 Swagger 规范)之间的差异。它可以帮助开发人员识别 breaking change 和非 breaking change。下面是 OpenAPI Diff 实现识别 breaking change 的步骤:
1. 将两个 OpenAPI 规范文件(或 Swagger 规范)加载到内存中。
2. 比较两个规范文件之间的差异,包括路径、参数、请求体、响应、安全定义等。
3. 标记每个差异属于 breaking change 还是非 breaking change。
4. 生成报告,以便开发人员可以查看 breaking change 和非 breaking change。
OpenAPI Diff 使用了一些规则来判断一个差异是否是 breaking change。例如,如果删除了一个路径或参数,那么它被认为是 breaking change。如果只是修改了一个参数的名称,那么它可能不是 breaking change。OpenAPI Diff 还支持自定义规则,开发人员可以根据自己的需求进行配置。
阅读全文