← 中文资源

简体中文版本

API 兼容性评审工作流

评审公共接口变更是否向后兼容,并要求有意的版本化决策。

阅读英文原文

目标

应防止对公共 API 的无意破坏。本工作流对比变更后与已发布的规范找出新增、变化或删除的元素,按兼容策略把每项变更标记为增补或破坏,对破坏性变更要求新版本或有文档的弃用路径,并识别受影响消费者并在发布前通知。

步骤要点

  1. 对比规范找出公共接口的增删改。
  2. 按兼容策略标记增补或破坏。
  3. 对破坏性变更要求版本或弃用路径。
  4. 识别并通知已知消费者。
# detect breaking API changes
npx oasdiff breaking old-openapi.yaml new-openapi.yaml

验证

按顺序执行上述步骤后,逐项确认每个步骤的预期状态均已满足;只有全部预期状态成立,才认为本流程完成。若某一步未达到预期状态,应先按排错提示排查,不要跳过继续,以免掩盖问题。

排错提示

  • 静默的破坏性变更会中断消费方。
  • 无消费者清单会浪费通知精力。
  • 仅靠人工会漏掉意外破坏。

适用边界

  • 外部消费方应先弃用再移除。
  • 宜在 CI 中强制检查。