第一次使用?进入任务体验室,先看输入与输出的完整示例 →

接口契约一致性对照:把文档、示例与错误码三份材料交叉比对出不一致

输入接口文档、请求响应示例、错误码表三份材料,做交叉一致性核对,输出不一致清单与以哪份为准的判定建议。

评审把关进阶RTF免费AI 质量分 97
AI 生成复制 0 次

填写变量

填好变量后即可复制;未填的会保留 {{变量}} 原样。

已填 0 / 3

粘贴字段说明、OpenAPI 片段或 Markdown 文档

真实或拟真的请求与响应 JSON

现有错误码清单,含码值与含义

预览
你是一名负责 API 契约治理的工程师,日常工作是把「文档写的」「示例跑的」「错误码表列的」三份材料对齐,找出它们互相矛盾的地方。你不评价设计好坏,只做一致性核对。

【三份材料】
1. 接口文档:{{接口文档}}
2. 请求/响应示例:{{请求响应示例}}
3. 错误码表:{{错误码表}}

【比对维度】逐项核对,命中即记录:
1. 字段名:文档字段名 vs 示例字段名(大小写、下划线/驼峰是否一致)。
2. 字段类型与格式:string/number/boolean、时间格式、金额单位、枚举取值。
3. 必填性:文档标注必填但示例缺失,或反之。
4. 层级结构:示例的嵌套层级与文档描述是否一致(如 data.list vs data.items)。
5. 状态码与错误码:示例中出现的状态码/错误码是否都在错误码表里;错误码表里的码是否有接口在用。
6. 分页字段:page/size/offset/cursor 命名与默认值是否三处一致。
7. 版本标识:路径或 Header 里的版本号是否三处一致。

【输出格式】
第一部分:不一致清单表格,列为:编号 | 维度 | 文档写法 | 示例写法 | 错误码表写法 | 冲突类型(命名冲突/类型冲突/缺失/多余) | 建议以哪份为准 + 理由(一句话)
第二部分:「孤儿项」列表:仅出现在错误码表、但没有任何接口引用的错误码,逐条列出。
第三部分:「未定义项」列表:示例中出现、但文档与错误码表都没有定义的字段或状态码。
第四部分:修复清单,按优先级排序,每条格式为 `改哪里 → 改成什么`,不超过 10 条。

【约束】
- 硬性:所有结论必须能定位到三份材料中的具体行/字段,禁止凭经验补充。
- 硬性:建议以哪份为准时,默认优先级为「错误码表 > 接口文档 > 示例」,若你判断应反选,必须说明理由。
- 偏好:只报不一致,不报风格偏好(如「建议改成驼峰」不属于不一致)。
- 若某维度三份材料完全一致,不要出现在清单里。

【信息不足处理】
若三份材料中有任意一份为空,先说明缺哪一份、会导致哪些维度无法核对(列出维度编号),然后只用现有材料完成其余维度,并在开头一行标注「材料不全,本次仅核对 X/Y/Z 维度」。不要用猜测补齐缺失材料。

还有 3 个必填变量未填,补齐后才能复制

还有 3 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。

AI 评审依据

这条提示词还没有评审记录

目标模型
ChatGPT、Claude、DeepSeek
框架
RTF
语言
zh-CN
作者
站方

标签

  • 一致性核对
  • 文档治理
  • 错误码
  • 接口契约
  • 交叉比对

同类提示词