用途:为服务或 API 平台产出一份完整的 API 版本化策略文档,让团队在演进 API 时有一致规则,避免破坏消费者。适用于定义版本策略、规划 API 弃用、判定破坏性变更等场景。
主要能力:
- 版本方案选择:对比 URL 路径(/v2/orders)、Accept 头、查询参数、GraphQL schema 演进,并给出与 API 类型和消费者类型绑定的理由。
- 生命周期策略:定义 STABLE、DEPRECATED、SUNSET、RETIRED 四阶段,含时长、SLA、是否允许新消费者及所需动作;规定最短稳定期与最大并行版本数。
- 破坏性变更分类表:覆盖字段删除/重命名、类型变更、可选转必填、端点删除、HTTP 方法变更、认证方案变更、错误结构变更、枚举扩展、分页默认值变更、校验收紧等,并列出非破坏性变更。
- 弃用流程:从 T-0 决策到 T+30 移除路由的清单,含 Deprecation、Sunset、Link 响应头与 410 Gone 响应体格式。
- 沟通模板:初始弃用通知、30 天警告、迁移指南模板(含 SDK 升级命令与验证清单)。
- 版本化文档与 SDK 版本对齐:按版本归档 OpenAPI/Protobuf/GraphQL schema,SDK 主版本与 API 主版本 1:1 对齐。
使用方式:需先提供 API 类型、当前版本方案、现有版本数与活跃消费者数、弃用时间约束、消费者类型;缺失时先询问再产出。GraphQL 需按 schema 演进方式调整方案章节。
限制:资料未提供具体收费、价格、平台支持范围或实际效果数据;文档中的时长、版本数等为可配置占位值,需按实际约束填写。