API 设计评审器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @kunlungrowth/kg-api-design-reviewer。
技能介绍
解决什么问题
团队在迭代中不断新增或修改 API 端点,Review 时容易陷入细节争论:命名风格不统一、HTTP 方法用错、状态码语义含糊、错误响应格式各写各的。等到上线才发现破坏性变更已经合入,v2 迁移成本被推高。
如何工作
这个技能在一轮评审内交付结构化结果,核心分三步。
规范审查(Lint)
逐项核对命名约定(资源用 kebab-case,字段用 camelCase)、HTTP 方法语义、URL 结构、状态码、错误响应结构与文档完整性。
破坏性变更检测
对比新旧两份 spec,识别端点删除、字段改名、类型变更、新增必填字段、状态码变化等,每条给出迁移动作建议。
质量评分卡
按一致性 30%、文档质量 20%、安全实现 20%、可用性 15%、性能模式 15% 加权打分,映射 A–F 等级。
最终输出结构化工件 ApiReview,包含 lint 问题列表、破坏性变更与迁移方案、评分卡、放行结论(approve 或 changes_required)。如果存在 breaking change,必须版本号升级或提供兼容方案后才可放行。同时附自然语言摘要,列出最该先改的 3 条。
适用边界
仅做设计层评审,不替代接口功能测试。安全项以实际实现与官方标准为准,不替用户编造接口数据。
使用场景
- 评审新增或修改端点的 PR,用规范 lint 核对命名、HTTP 方法和状态码。
- 为已有 API 做 v2 迁移审计,对比新旧 spec 识别破坏性变更。
- 为团队建立 API 规范,统一 URL 结构、错误响应与文档标准。
- 合并 PR 时作为 CI 门禁,依据 lint 结果与评分卡给出放行结论。
适合人员
- 后端工程师:在 API 上线前快速定位命名、方法和文档类问题。
- 前端工程师:理解接口契约与破坏性变更,减少联调返工。
- API 平台团队:为全团队制定并维护一致的设计规范。
- 技术负责人:在评审中快速拿到放行或打回的客观依据。