GPT中文小秘书挑几下就能开工
我积分

核对接口文档字段和实际返回差异

关于「核对接口文档字段和实际返回差异」:能拿到什么、要点选什么、怎么办

文档和返回逐字段对,差异一眼清。接口文档核偏是把接口文档与实际返回逐字段对照;在 GPT中文网点选几项,能直接拿到字段差异表、文档修正稿和 curl 用例。

能拿到什么

  • 推荐:字段对齐差异表(xlsx)(每行一个字段:文档字段、实际返回、差异类型、建议改哪边)

要你点选的几项

上传接口文档、上传返回报文或截图、文档来源、比对范围、上传错误码表、接口基本信息、curl 用例格式。多数点一下就行,没选的按常见情况替你定,交付时说清哪几项是按默认的。

怎么办

  1. 上传接口文档,选好文档来源和比对范围
  2. 上传实际返回报文或截图,补齐接口路径、方法
  3. AI 按字段名做集合差,标缺失、类型不符、必填差异
  4. 对照错误码表统计覆盖,生成 curl 用例清单
  5. 人工核差异:真 bug 还是文档过时,定改哪边

别人还这样说

  • 帮我把这份 Swagger 和实际返回的 JSON 对一下,看哪些字段对不上。
  • 联调发现文档写的跟返回不一样,给我列个差异表呗。
直接说你要办的事。下面是别人怎么办的,点任何一项就换成你自己的。左边是别人怎么办的,右边是你的,点一项就开始改。
示范 · 别人这样说

「抓包报文在附件里,跟接口文档逐字段核一下错误码和类型。」

替他选了:错误码

按示范选好的 点一项就变成你的

你的成品会在这里出现
示例成品 · 不是你的按示范写的,看个样子
示例:接口文档与实际返回字段对齐差异表(示意) 接口:GET /api/v1/orders/{id},环境:测试 文档来源:Swagger 2.0,比对时间:××××-××-×× 统计:文档字段 18 个,实际返回 16 个;缺失字段 2 个,类型不符 1 个,必填差异 1 个;错误码文档 6 个,实际覆盖 4 个。 字段 | 文档定义 | 实际返回 | 差异类型 | 建议 orderId | string, 必填 | string | 无 | — amount | number | string | 类型不符 | 改代码返回 number 或改文档为 string items | array, 必填 | 未返回 | 缺失 | 确认空数组是否省略,改文档加示例 remark | string | 未返回 | 缺失 | 文档标可为空,建议文档注明不返回 status | enum[A,B,C] | D | 枚举不符 | 与对方确认 D 含义,补枚举 updatedAt | string(date-time) | 时间戳数字 | 类型不符 | 统一为 ISO 字符串或数字,改文档 错误码对照: 文档错误码 | 实际出现 | 覆盖情况 | 建议 40001 | 是 | 已覆盖 | — 40002 | 否 | 未覆盖 | 确认是否废弃 50001 | 是 | 已覆盖 | — 50003 | 否 | 未覆盖 | 补 curl 用例验证 文档修正稿(docx 摘要): - items 字段补「可能不返回,表示空列表」说明 - remark 标注「成功时不返回」 - status 枚举增加 D,备注含义待确认 - updatedAt 类型改为 number(毫秒时间戳) 补充 curl 用例: 1) 正常:curl -X GET '…/orders/1' -H 'Authorization: Bearer …' 2) 空列表:curl -X GET '…/orders/2' … 3) 错误码 50003:curl -X GET '…/orders/999' … 4) 缺必填参数:curl -X GET '…/orders/' … 结论由持证人员核对后才能用:差异项需人工判断是真 bug 还是文档过时。

GPT中文 也可能出错,成品请自己核对关键数字和事实。条款 · 隐私