SuperAPI AI 工具集

api-versioning-deprecation-planner

编程与开发

查看项目

更新于 10-16 03:16

技能介绍

该技能用于在不破坏现有客户端的前提下安全演进 API,围绕版本策略、弃用时间表、迁移指南与向后兼容展开规划。

主要能力:比较 URL 版本(如 /api/v1/users、/api/v2/users)、Header 版本(Accept: application/vnd.api.v1+json)和查询参数版本(/api/users?version=1)的优缺点;生成弃用时间表模板(公告、迁移期、最终警告、下线);提供弃用响应头示例(Deprecation、Sunset、Link、Warning);区分破坏性与非破坏性变更;给出迁移指南模板,覆盖认证(查询参数 API Key 改为 Authorization: Bearer xxx)、响应字段命名(snake_case 改 camelCase)、分页(page/per_page 改为 cursor/limit);提供向后兼容策略,如并行版本路由、适配器模式、功能开关;并包含客户端通知邮件模板、迁移进度监控指标与回滚计划。

使用方式:按输出清单逐项产出——确定版本策略、编写弃用时间表(6个月以上)、撰写迁移指南、记录破坏性变更、制定兼容方案、起草客户沟通、搭建监控面板、编写回滚计划、准备支持资源。迁移验证示例命令保留原文:curl -H "Authorization: Bearer xxx" https://dev-api.example.com/v2/users。

适用场景:API 版本升级、旧版本下线、多客户端兼容治理。

限制:资料未提供具体平台绑定、价格或收费信息,也未说明实际执行环境;示例中的域名、日期与邮箱为占位符,需按实际情况替换。