SuperAPI AI 工具集

api-design-quality-review

编程与开发

查看项目

更新于 10-16 01:34

技能介绍

用途:在 API 实现或版本化之前,对 API 设计、OpenAPI/契约、请求响应示例、错误模型、授权、幂等、分页、状态码、版本演进和消费者影响做质量审查,判断操作、输入输出、错误、权限与兼容性演进是否可验证,并找出跨消费者、版本或迁移计划的契约缺口。

主要能力:产出 API-## 发现项与验证准备;构建操作/字段覆盖矩阵,把每个缺口绑定到来源、证据、影响和验证方法;区分契约事实、有证据的推断、建议与需人工决策的事项;支持 Markdown 默认输出,也可按要求输出表格、CSV 或 JSON,并保留证据、状态、影响、负责人和验证字段。

使用方式:先阅读 prompts/api-design-quality-review.md,提供目标、范围、材料、环境和可用证据;按提示做输入审计并遵循输出契约,信息不完整时给出有边界的第一轮结果。每个发现项需保留来源、证据状态、影响、负责人角色、关闭条件和验证方法。回归时读 evals/eval.yaml 及其用例;触发检查用 evals/trigger-prompts.csv 和 evals/local-rules.json,缺少选择轨迹视为 BLOCKED。

适用场景:示例不完整、边界未定义或缺少运行时证据时;需要检查契约缺口、兼容性演进和迁移影响时。

限制:不发送请求、不做负载测试、不执行安全测试,也不替团队选择最终 API 版本策略;不得把结构化格式或静态清单当作执行、通过、批准或发布证据;没有执行身份、时间、环境、输入、响应和原始结果时,运行时状态保持未验证、未执行或未评估;不能从一个示例推断全部字段、错误、权限、限流、幂等或版本规则。