名称: api-兼容性分析器 描述: 分析API版本间的变更，检测破坏性变更，评估消费者影响，并提供迁移策略建议 允许工具: [“Bash”, “Read”, “Write”, “Grep”, “Glob”, “Edit”]
API兼容性分析器技能
分析API版本间的变更，以检测破坏性变更、评估消费者影响，并建议迁移策略。
目的
为API版本管理提供支持，包括：
- 破坏性变更检测
- 弃用分析
- 版本比较
- 消费者影响评估
- 迁移路径建议
能力
1. 破坏性变更检测
- 检测移除的端点
- 识别移除的字段
- 发现类型变更
- 标记必需字段的添加
2. 弃用分析
- 跟踪弃用的端点
- 监控弃用时间线
- 识别弃用API的使用情况
- 规划下线计划
3. 版本比较
- 比较OpenAPI规范
- 生成详细差异
- 分类变更
- 记录迁移
4. 消费者影响评估
- 映射受影响的消费者
- 估算迁移工作量
- 识别高影响变更
- 优先通知
5. 迁移路径建议
- 推荐升级步骤
- 建议兼容层
- 提出版本策略
- 设计适配器模式
6. 兼容层设计
- 设计门面端点
- 规划响应转换
- 处理版本协商
- 实现回退机制
工具集成
| 工具 | 用途 | 集成方法 |
|---|---|---|
| OpenAPI-diff | 规范比较 | CLI |
| Optic | API变更检测 | CLI |
| Akita | 基于流量的检测 | API |
| swagger-diff | Swagger比较 | CLI |
| Spectral | API检查 | CLI |
输出模式
{
"analysisId": "string",
"timestamp": "ISO8601",
"versions": {
"base": "string",
"target": "string"
},
"changes": {
"breaking": [
{
"type": "string",
"path": "string",
"description": "string",
"migration": "string"
}
],
"nonBreaking": [],
"deprecations": []
},
"impact": {
"consumers": [],
"severity": "string",
"migrationEffort": "string"
},
"recommendations": []
}
与迁移流程的集成
- api现代化: 兼容性验证
- 框架升级: API影响分析
相关技能
api-清单扫描器: 端点发现openapi-生成器: 规范生成
相关代理
api现代化架构师: 版本策略