Agent Skills
返回列表
💻

API 设计评审助手

开发编程 更新于 2026.08.30

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @kunlungrowth/kunlun-api-design-reviewer。

技能介绍

问题从哪来

接口联调扯皮,往往不是因为业务难,而是契约没在对齐前写清:路径与动词不一致、字段含义各说各话、错误码前端无法分支处理。评审 PR 时也容易先纠结格式,却漏掉并发边界与鉴权缺口。SKILL 把「Api Design Reviewer」场景嵌进一套可复用的工程方法里——听到 接口 / API / 契约 就走 API 设计能力,听到 review / 评审 就走代码评审,而不是给一段泛泛的建议。

技能如何工作

输入侧按能力拆分,输出侧给可直接贴进文档的结构化物:

  • API 设计:给出 资源 + 操作,产出 RESTful 路径约定、字段契约与错误码表,便于前后端对齐后再写实现。
  • 代码评审:贴 diff 或 PR 描述,按正确性 → 安全 → 可维护性排序,问题分级为阻断 / 建议 / 可选。
  • 技术方案 / 架构权衡:补充需求与规模约束,得到背景、选型对比、风险与回滚项。
  • 调试排错:提供报错与上下文,按复现 → 隔离变量 → 看日志链路 → 假设验证的流程组织结论。
  • 工程规范:按语言或框架拉清单,并标出常见反模式。

工作流上,代码评审强调「先读懂意图再判阻断级」;线上排错强调「先稳定复现再改代码」。行业纵深部分明确 API 重契约:幂等、限流、鉴权、版本向后兼容应作为接口设计的一等公民。

边界与注意

输出是方法论与模板,不替代合并决策或资质判断;涉及密钥凭证只给脱敏示例。不接入付费服务或外部账号。若结果不够贴场景,应在输入里写清人群、约束与现有技术栈,让对应能力收窄交付范围。

使用场景

  • 新资源域要定路径、动词与分页参数,需在联调前输出字段契约和错误码表
  • PR 改动涉及鉴权与并发,需要按阻断/建议分级写清评审理由而非只改命名
  • 线上接口返回混杂错误码,需按报错与链路上下文整理复现步骤与修复验证清单
  • 微服务拆分要在两个存储方案间选型,需表格化利弊、适用规模与回滚条件

适合人员

  • 负责对外 HTTP 接口的后端工程师,希望在写 handler 前先锁定 REST 约定与错误码语义
  • 担任 Code Owner 的技术负责人,需要对 diff 先验正确性与安全再讨论风格
  • 全栈开发者在前后端并行迭代时,需要可机器识别的契约文档减少联调返工
  • 独立开发者维护多版本 API,需要向后兼容与幂等、限流条款写入设计 checklist