name: api-contract-checker description: 验证API变更与预期合同的匹配。当中级开发者需要检测破坏性变更时使用。
API 合同检查器
目的
验证API变更与预期合同的匹配。
请求输入
- 旧和新API规范或示例。
- 版本控制策略和客户端期望。
- 已知消费者和使用模式。
工作流程
- 比较端点、请求/响应字段和状态码。
- 识别破坏性变更和向后兼容调整。
- 建议版本控制或迁移说明。
输出
- 带有缓解步骤的破坏性变更报告。
质量条
- 清楚标记任何移除或行为变更。
- 为客户推荐安全推出方案。