首页/开发/代码质量与评审速查/评审检查项:接口与兼容性
代码评审64 条

评审检查项:接口与兼容性

接口变更评审:公有 API 的增删改是否破坏兼容、默认值与序列化格式变化、版本策略与弃用流程是否完整。

  • 破坏性变更识别:删字段、改类型、改语义、改默认值
  • 序列化:JSON 字段可选性与 protobuf 字段号变化的影响
  • 调用方盘点:公共接口变更是否同步更新所有使用方
  • 弃用流程:先标记 deprecated、留迁移窗口,再移除
涉及兼容性的改动,评审时应要求作者给出兼容性与回滚分析。
兼容检查字段增删、类型、默认值、错误码与序列化格式
弃用流程标记 deprecated、文档公告、通知调用方、到期移除

易错点

  • 默认值的小变化被当作非破坏性:下游行为静默改变
  • 删除字段不走过弃用流程:调用方升级时直接失败

数据来源与参考

  • Semantic Versioning 2.0.0(破坏性变更定义)
  • Google API Design Guide(兼容性策略)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌