核对接口文档字段和实际返回差异｜程序员AI场景表格模板

要准备的

关于这件事怎么办

只有返回截图没有原始 JSON，能比对字段吗？

可以，按截图里能看清的字段名和值做比对，但类型和嵌套结构可能判断不全，建议尽量给原始 JSON 或抓包文件。

文档和返回不一致时，该改代码还是改文档？

看契约谁为准：对外接口以已发布文档为准就改代码；内部联调以实际行为为准就改文档，差异表里会给出建议方向，最终由你确认。

错误码覆盖怎么算？

把文档错误码表与实际返回里出现过的 code 做集合对照，标出已覆盖、未覆盖、实际多出的码；未覆盖的会生成对应 curl 用例供复现。

核对接口文档字段和实际返回差异需要准备什么？

需要填的是：上传接口文档、上传返回报文或截图、文档来源、比对范围、上传错误码表、接口基本信息、curl 用例格式。每一项点一下就行，多数不用打字。点「直接办这件事」就开工；没选全也能先办，回头补了随时能改。

能拿到什么成果？

交付形式是表格——平台直接做好表格，能下载成 Excel。在GPT中文网（www.gpt.com.cn）按字段填完即可拿到。文字类成果免费生成，免注册即可试。

什么情况下需要核对接口文档字段和实际返回差异？

联调时文档跟返回对不上，靠人眼一行行翻，漏字段漏错误码，返工还背锅。遇到这种情况，把信息按字段点选一遍，AI 按你点的出成品，不用自己琢磨怎么说。

适合谁用？

前后端、全栈、测试和独立开发者，经常照着接口文档联调的人。不需要 AI 使用经验，按字段填完即可。