SuperAPI AI 工具集

dust-breaking-changes

编程与开发

查看项目

更新于 10-15 21:35

技能介绍

用途:该技能用于在修改私有 API 时防止引入破坏性变更。它在涉及 API 代码的工作中自动生效,无需手动调用,核心要求是:未经用户明确批准,绝不允许引入破坏性变更。

主要能力:识别破坏性变更并列举常见类型,包括删除或重命名 API 端点、修改请求或响应 schema、从响应中移除字段、改变字段类型(如 string 转 number、object 转 array)、把可选字段改为必填、重命名字段、修改认证或授权要求、更改 HTTP 方法或状态码、改变错误响应格式或错误码、移除查询参数或把原本可选的参数改为必填、要求新增请求头或改变请求头校验。

使用方式:在改动 API 代码前先确认所涉范围,包括 front/pages/api/** 下的路由处理器、这些路由使用的请求/响应类型定义、API 处理器中的校验 schema(如 Zod)以及影响 API 行为的中间件。随后分析影响:该改动是否会改变响应结构、是否要求 API 使用方更新代码、是否可能破坏现有集成或客户端。若任一答案成立,应立即停止并发出警告,说明具体会破坏什么、影响哪些端点、使用方需要更新什么,然后等待用户明确批准。获批后才可实施。

适用场景:修改 front/pages/api/** 或 front/app/api/** 中的文件、更改对外导出并用于 API 响应的类型定义、更新 API 端点使用的校验 schema,或重构影响 API 契约的代码时。

限制与安全替代:安全改动包括新增可选字段;建议用弃用策略、为新必填字段提供合理默认值等方式实现向后兼容。文档未提供具体的安装命令、运行命令、收费信息或支持的平台信息。