1. 基本信息
| 项目 | 内容 |
|---|---|
| 名称 | API Breaking Change Detector |
| 作者/维护者 | github/awesome-copilot 社区贡献(PR 作者 sudhirp25,经官方仓库审核合并) |
| 来源链接 | https://github.com/github/awesome-copilot/tree/main/skills/api-breaking-change-detector |
| 许可证 | MIT(仓库级,来自 GitHub API) |
| GitHub Stars / Forks | 合集仓库整体 39,410★ / 5,009 forks(来自 GitHub API;该数字属整个合集,不代表本技能自身热度) |
| 最新版本 | 无独立版本号;最近一次提交 2026-09-22(来自 GitHub API) |
| 安装方式 | 复制 skills/api-breaking-change-detector 目录到本地 agent 的 skills 目录;或用第三方安装器 npx @skills-hub-ai/cli install github-copilot-api-breaking-change-detector |
2. 功能介绍与亮点
对着一个 C# Web API 项目,把后端的 Controller / DTO / 路由定义,和前端 TypeScript / JavaScript(React、Angular、Vue、Svelte、Node.js,或 Fetch/Axios/NSwag 等客户端)逐一核对,找出双向的“契约漂移”:后端改了字段名/删了字段/加了必填参数/换了状态码会不会炸前端;前端还在发的字段后端是否已不再接收(区分“无害废弃字段”与“会导致运行时 undefined 的静默 bug”)。
核对逻辑考虑了 C# 的 [JsonPropertyName]、全局 JsonNamingPolicy.CamelCase、C# 11 required 关键字等命名与可空性细节,并对路由做归一化匹配。只读产出审计报告,不修改代码,找不到对应消费方时明确标注“未找到”而非瞎猜。整份技能是单文件 SKILL.md(约 6.7KB),无需额外脚本或依赖。
3. 适用场景
固定分类:工程效率与代码质量
适用于任何前后端分离、后端用 C# Web API 的项目——在合并一个改动 DTO/Controller 的 PR 之前,先跑一遍看看会不会悄悄弄坏某个前端组件;也适用于排查“生产环境某个页面数据突然变 undefined“这类由契约漂移引起的静默故障,倒查是哪次后端改动导致的。受益人群是全栈或后端为主、需要与独立前端团队协作的开发者。
4. 跨 Agent 兼容性
| Agent | 结论 | 依据 |
|---|---|---|
| Claude Code | ✅ 原生支持 | 标准 SKILL.md(YAML front matter + 指令正文),符合 Agent Skills 规范,可直接复制进技能目录 |
| Codex | ⚠️ 需适配 | SKILL.md 标准格式在 Claude Code / Codex / GitHub Copilot 间通用,但 Codex 不会自动发现自定义技能目录,需在会话中显式引用路径 |
| OpenClaw | ❓ 未验证 | 未找到该平台对此技能的适配记录 |
| Hermes Agent | ✅ 原生支持 | Hermes 按路径扫描子目录探测 SKILL.md,标准格式可被直接发现 |
5. 推荐理由
前后端契约核对目前多半靠人工 review 或等运行时报错才发现,这个技能把“改了 DTO 会不会弄坏前端”变成合并前几分钟就能跑完的静态核对,专门处理了命名策略、可空性、动态路由拼接这些容易被人工 review 漏掉的细节。产出是结构化报告、不改代码,风险低,适合作为 PR 合并前的例行检查步骤。
6. 评分
| 维度 | 分数 | 说明 |
|---|---|---|
| 受欢迎程度 | 7 | 2026-09-22 合并上线,skills.sh 装机 6 次,暂无独立第三方讨论;证据不足以证明热度高或低,取中间值 |
| 可用性 | 9 | 单文件、复制即用,SKILL.md 含完整流程说明与输出格式规范,近期(4 天前)有维护,无付费依赖 |
| 安全性 | 9 | 纯提示词/文本核对,无 shell 执行、无联网外发、不要求任何 API key 或凭据;正文明确声明“只产出报告、不修改代码”,未发现可疑指令;License 清晰(MIT) |
安全检查清单:①无 shell 命令执行 ②无运行时联网外发 ③不要求凭据 ④正文与流程中未见可疑指令或混淆代码 ⑤作者为近期注册的 GitHub 账号,但内容经 github/awesome-copilot 官方仓库 PR 审核合并,未见造假迹象 ⑥License 明确(MIT) ⑦最近一次提交 4 天前,维护活跃
综合评分:8.33
7. 跟同类 Skills 相比的优势
| 技能 | 定位 | 与本技能的差异 |
|---|---|---|
| SQL Object Impact Analysis(同仓库) | 追踪数据库表/字段/存储过程被谁引用,评估修改数据库对象的影响范围 | 聚焦数据库对象依赖,本技能聚焦 API 契约(Controller/DTO)与前端消费方之间的漂移 |
| ASPNET Minimal API OpenAPI(同仓库) | 用 OpenAPI 文档脚手架搭建新的 Minimal API 端点 | 是“从零生成新端点”的正向流程,本技能是“审计既有契约有没有被悄悄改坏”的反向核对,两者在原 SKILL.md 中互相点名区分 |
| Optic / Buf breaking-change 等独立商业化契约测试工具 | 对比两份已导出的 OpenAPI/Protobuf 规范文件,检测破坏性变更 | 需要额外安装 CLI、预先导出规范文件;本技能直接读取 C# 源代码与前端源码,不依赖预先维护的 spec 文件,省去一道导出步骤 |
8. 用户评价
该技能目前在第三方平台尚无具名用户评价,除官方仓库合并记录与镜像至第三方技能市场(skills-hub.ai)外,未检索到独立评价。
9. 其他补充
无。
10. 安装使用方式
- Claude Code:将
skills/api-breaking-change-detector目录复制到~/.claude/skills/下,重启会话后即可通过对话触发(如“检查这个改动会不会破坏前端”) - 第三方安装器:
npx @skills-hub-ai/cli install github-copilot-api-breaking-change-detector - Codex / Hermes Agent:将同一目录放入各自的技能扫描路径;Codex 需在会话中显式引用路径
安装后无需额外配置,无 API key,直接对话触发即可。
11. 注意事项
- 仅覆盖 C# Web API 后端 + TypeScript/JavaScript 前端组合,其他技术栈(如 Python/Java 后端)不在设计范围内
- 是静态文本核对,无法覆盖反射式 ORM 映射或复杂动态 SQL 拼接场景,报告中会明确标注“未能静态解析”的部分,需人工二次确认
- 只读产出报告,不会自动修复发现的问题