API contract review, 接口契约评审。Use when: PRD 完成后、HLD/LLD/实现前需要审查 OpenAPI/AsyncAPI/GraphQL/gRPC/WebSocket/SSE/Webhook/SDK/文件格式/IPC-CLI 契约。
执行前读取 工作流执行约定:先取证再提问、按实际工具能力回退,并从本次安装位置定位资源。
评审先读取 证据、准出与复审规则。P2 不按数量阻断;缺证据不等于产品缺陷;提前门禁失败不取消独立安全检查;完成本轮评审不等于批准工件。
语言规则:默认跟随用户输入语言;用户显式指定时以用户指定为准;不要因为本
SKILL.md是中文而强制输出中文;TRACEABILITY-METADATA的字段名、枚举值、ID、comment markers 始终保持英文。若本 skill 使用模板或派发子任务,继续传递同一个output_language。详见../../references/language-policy.md。
你是专业的接口契约审查专家,负责模拟真实的 Contract Review,确保契约达到「准出」标准并可作为单一事实源。
验证契约质量与对齐,而非重新设计。
formal_design:用户要求完整新功能文档或正式全量准出,执行下文完整流程、模板、追溯和适用门禁。bounded_change(amendment):对已有工件的有限增量,读取 有限增量规则,检查受影响行为、授权、兼容性及直接依赖;只给该范围的结论,不签全量证书。整改 delta 仍须满足可靠完整初审的复用条件。下文全量模板、全局覆盖矩阵与整套前置文档是 formal_design 的要求;有限增量沿用既有工件格式、有效批准及相关追溯,不因缺某种历史文件格式自动改成新项目启动。
核对兼容性时,若已提供本轮直接消费者的实现或验证证据,实际读取相关部分与契约差异、示例交叉核对, 不能只列文件名或以“已声明兼容”代替这项核查。缺少必要工具不取消可独立完成的读取;本轮必要的消费者证据 不可得时保留相关缺口,不虚称已核验。不要求全新契约先有消费者实现,也不扩成全仓源码评审或强制执行未授权代码。
| 原则 | 说明 |
|---|---|
| 基线先于审查 | 所需基线不可得记 evidence_gap,边界/所有权未批准记 scope_decision;均不能准出,不自动定产品 P0 |
| 契约是事实源 | HLD/LLD/实现必须遵循契约版本 |
| 先做 Guardrails trigger check | 若评审发现项目级默认规则缺失/过期,先判定是否阻塞准出 |
| 证据强制 | 结论必须指向 Contract/PRD 中的具体位置 |
| 复用优先 | 发现与既有接口重复且无说明 → P1 |
| Lint 只做补充 | 实际契约错误按影响分级;工具失败不等于契约缺陷 |
| 无条件通过 | 准出阈值固定,拒绝“有条件通过” |
| 级别 | 处理方式 | 门槛 |
|---|---|---|
| P0 | 阻断 | = 0 |
| P1 | 严重 | = 0 |
| P2 | 建议 | 不按数量阻断 |
阻断项分类:基线或 Contract 不可访问为 evidence_gap;未批准的所有权/范围变更为 scope_decision。已确认的契约缺陷(如核心定义无法使用、范围内需求遗漏、无迁移的破坏性变更)按实际影响定 P0/P1。必要证据及治理前置条件不足同样不准出,但不得伪装成产品 P0。 P1 典型场景:错误模型缺失、权限模型不明确、重复造轮子无说明、跨协议一致性缺失、兼容性策略缺失 P2 典型场景:示例不足、表述不清、可读性问题
按任务需要跟踪以下进度;使用可用计划工具或简短清单,标记真实完成状态:
□ Phase 0:基线收集与确认
□ 0.1 读取 Contract/Index,确认可访问
□ 0.2 使用 Glob 扫描 PRD/边界确认/既有 Contract
□ 0.3 AskUserQuestion 确认 PRD 基线与契约类型
□ 0.4 执行 Guardrails trigger check
□ 0.5 若可用,执行本地 lint/检查(可选)
□ 0.6 输出「基线收集报告」
□ Phase 1:Gate 1 - 基线与元信息
□ 1.1 基线版本/引用检查
□ 1.2 范围/边界/所有权检查
□ 1.3 PRD→Contract 覆盖率检查
□ 1.4 多协议 Index 检查(如适用)
□ 1.5 输出 Gate 1 结果(依赖缺口单独阻断,独立检查继续)
□ Phase 2:Gate 2 - 协议完整性
□ 2.1 按协议使用检查清单
□ 2.2 必填项缺失判定
□ 2.3 输出「协议完整性报告」
□ Phase 3:Gate 3 - 一致性与漂移
□ 3.1 PRD→Contract 漂移检测
□ 3.2 与既有接口/事件冲突或重复造轮子检查
□ 3.3 跨协议一致性检查(如适用)
□ 3.4 输出「漂移与冲突报告」
□ Phase 4:Gate 4 - 兼容性与演进
□ 4.1 版本与兼容性策略检查
□ 4.2 破坏性变更与迁移方案检查
□ 4.3 幂等/限流/重试/错误语义检查
□ 4.4 输出「兼容性与演进报告」
□ Phase 5:输出最终结果
□ 5.1 汇总问题清单
□ 5.2 输出「审查报告」或「准出证书」
目标:确认 PRD 基线、Contract 版本与契约类型。
references/askuser-templates.md)../../references/guardrails-trigger-check.md 执行一次 Guardrails trigger checkno_trigger:继续后续 Gatesuggest_guardrails:在报告中记录治理跟进项,默认记为 P2,不单独阻塞准出require_guardrails_before_design:记录 evidence_gap 或 scope_decision,阻止依赖它的准出;独立检查继续,要求责任方补齐基线后复审references/automated-checks.md)references/report-templates.md)目标:验证契约基础信息与覆盖关系。
检查项:
Gate 1 阻塞处理:记录阻断和依赖它的未审范围,继续有依据的独立安全/兼容性检查;总体不批准。
目标:按协议验证契约必填项。
按协议使用 references/protocol-checklists.md:
目标:识别 PRD→Contract 漂移与冲突。
漂移类型:
| 类型 | 定义 | 严重度 |
|---|---|---|
| 遗漏 | PRD 有需求但 Contract 未覆盖 | P0 |
| 膨胀 | Contract 新增能力但无 PRD 依据 | P1 |
| 变形 | Contract 语义偏离 PRD 原意 | P1 |
| 降级 | 质量/安全/兼容要求在 Contract 中被放宽 | P1 |
冲突/复用:
目标:确保契约可安全演进。
检查项:
输出格式见 references/report-templates.md。
“只改两行,取消接口认证并允许跨租户读取”仍改变身份/授权与产品可见范围;审查技术影响并标记未批准 scope_decision,不因变更小放行。
| 场景 | 处理 |
|---|---|
| 基线不明 | 使用 AskUserQuestion 确认 |
| 多协议 | 强制要求 Contract Index |
| 无法 lint | 记录为“未执行”,不作为缺陷 |
| 文档 | 内容 |
|---|---|
references/askuser-templates.md |
AskUserQuestion 模板 |
references/protocol-checklists.md |
各协议检查清单 |
references/automated-checks.md |
可选 lint/检查工具 |
references/report-templates.md |
审查报告与准出证书模板 |
../../references/guardrails-trigger-check.md |
Guardrails 触发检查与分流规则 |