接口联调报错对照表:从请求样本反推契约不一致
面向前后端联调场景,输入接口契约(OpenAPI 片段/字段定义)、失败请求样本、双方对同一字段的理解,输出「字段级不一致对照表」+ 最小复现用例 + 修复与防回归建议。
排查纠错进阶COSTAR免费AI 质量分 97
AI 生成复制 0 次
填写变量
填好变量后即可复制;未填的会保留 {{变量}} 原样。
粘贴接口文档片段、Swagger/OpenAPI、或字段定义表。
至少一组失败样本,含请求体、响应体、状态码。
写清调用方(前端/第三方)按什么语义传参,便于定位认知差。
写清服务端校验、序列化、类型转换的关键实现。
影响序列化/类型转换类问题的判断。
决定修复方案偏向改哪一端。
预览
你是负责前后端联调与接口契约治理的技术负责人,擅长从一组失败样本里定位「契约、实现、理解」三者之间的偏差。 【接口契约】 {{接口契约}} 【失败请求与响应】 {{失败请求样本}} 【调用方对字段的理解】 {{调用方理解}} 【服务端实现要点】 {{提供方实现}} 【技术栈】 {{技术栈}} 【期望的联调结果】 {{期望结果}} 请严格按以下结构输出: ## 1. 不一致对照表 用 Markdown 表格,列为:字段名 | 契约定义 | 调用方实际传入 | 服务端实际处理 | 偏差类型(类型/单位/枚举/必填/命名/编码/空值)| 是否导致本次报错(是/否/存疑)。 只列与本次报错相关或高风险的字段,最多 12 行。 ## 2. 最小复现用例 给出一个最小可复现的请求(curl 或 HTTP 报文),并说明它命中了对照表中的哪一行。 ## 3. 根因判定 用一句话给出根因,并标注归属:契约文档问题 / 调用方实现问题 / 服务端实现问题 / 双方理解不一致。 若证据不足以判定归属,写「无法判定,需补充:…」。 ## 4. 修复方案 分两条给出: - 快速修复(不改契约,改哪一端、改什么) - 规范修复(是否要改契约、改后如何通知调用方、是否需要版本号) 每条都写清验证方式(用什么请求验证通过)。 ## 5. 防回归建议 最多 3 条,必须具体到工具或机制(如契约测试、Schema 校验、CI 卡点),不要写「加强沟通」这类空话。 规则: 1. 若 {{接口契约}} 缺失或只有自然语言描述,先在开头声明「契约不完整,以下按字段名与样本推断」,并在对照表中把「契约定义」列标注为「推断」。 2. 不得编造未在输入中出现的字段或错误码。 3. 若 {{期望结果}} 为空,默认给出「不改契约」的快速修复方案,并说明该默认假设。 4. 全文不超过 1200 字,表格不计入字数。
还有 2 个必填变量未填,补齐后才能复制
还有 2 个变量没填。照样能跑——缺失的部分会按常见情况假设,并标注在成品末尾。
AI 评审依据
这条提示词还没有评审记录
- 目标模型
- ChatGPT、Claude
- 框架
- COSTAR
- 语言
- zh-CN
- 作者
- 站方
标签
- 接口联调
- 契约不一致
- 前后端协作
- 字段校验
- openapi
同类提示词
接口 5xx 故障根因定位与修复方案
97AI 质量分面向后端/全栈工程师,输入接口报错信息、请求响应样本、近期变更与调用链日志,输出按概率排序的根因假设、可执行验证步骤(含具体命令/SQL/curl)与分优先级修复方案。
排查纠错进阶CRISPE免费
AI 生成站方 · 复制 0 次