名称: 弃用管理器 描述: 管理API和SDK的弃用生命周期 允许使用的工具:
- 读取
- 写入
- 编辑
- 全局搜索
- 文本搜索
- Bash
弃用管理器技能
概述
此技能管理API和SDK的完整弃用生命周期,从最初的弃用通知到最终停止服务,确保API消费者能够平稳过渡。
能力
- 跟踪弃用时间线和里程碑
- 在SDK代码中注入弃用警告
- 向API消费者发送停止服务通知
- 自动生成迁移文档
- 监控已弃用端点的使用情况
- 配置停止服务和弃用HTTP标头
- 根据使用阈值实施渐进式弃用
- 适当归档已弃用的文档
目标流程
- 向后兼容性管理
- API版本控制策略
- SDK版本控制和发布管理
集成点
- 停止服务标头注入中间件
- 弃用注解处理器
- 使用分析系统
- 电子邮件/通知服务
- 文档平台
输入要求
- 弃用政策和时间线
- 受影响的端点/功能列表
- 替换/迁移路径
- 消费者通知要求
- 使用监控访问权限
输出产物
- 弃用时间线文档
- SDK弃用注解
- 迁移指南
- 停止服务标头配置
- 消费者通知模板
- 使用监控仪表板
- 已归档的文档
使用示例
技能:
名称: 弃用管理器
上下文:
弃用政策: ./docs/弃用政策.md
功能:
- 功能ID: 旧版认证
弃用日期: "2024-06-01"
停止服务日期: "2024-12-01"
替换方案: oauth2流程
通知渠道:
- 电子邮件
- 仪表板
- SDK警告
使用阈值: 100
最佳实践
- 提前宣布弃用(6个月以上)
- 提供清晰的迁移路径和示例
- 在停止服务前监控使用情况
- 发送多次提醒通知
- 保留已弃用文档但做好标记
- 在完全停止服务前实施渐进式速率限制