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

对一遍接口字段和文档

关于「对一遍接口字段和文档」:能拿到什么、要点选什么、怎么办

抓包 JSON 对文档,字段差异一张表看清。接口字段对比是把抓包 JSON 和接口文档逐字段比对;在 GPT中文网点选几项,能直接拿到字段差异对照表。

能拿到什么

  • 推荐:接口字段差异对照表(字段名、文档类型、实际类型、差异说明四列,多缺字段标红)

要你点选的几项

JSON 来源、上传 JSON 材料、上传接口文档、比对范围、忽略字段、数组取几条。多数点一下就行,没选的按常见情况替你定,交付时说清哪几项是按默认的。

怎么办

  1. 从 Network 面板复制接口返回 JSON
  2. 上传或粘贴 JSON,并上传接口文档
  3. 勾选要比对的范围,填忽略字段
  4. 查看字段差异对照表,核对多缺字段

别人还这样说

  • 帮我把抓包返回的 JSON 和接口文档对一下字段
  • 看看返回里哪些字段跟文档不一样
直接说你要办的事。下面是别人怎么办的,点任何一项就换成你自己的。左边是别人怎么办的,右边是你的,点一项就开始改。
示范 · 别人这样说

「给我列个字段差异表,多出来和缺的标一下」

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

你的成品会在这里出现
示例成品 · 不是你的按示范写的,看个样子
示例:接口字段差异对照表 接口 | GET /api/user/profile 核对时间 | 2025-03-14 字段名 | 文档类型 | 实际类型 | 差异说明 id | number | number | 一致 name | string | string | 一致 avatarUrl | string | string | 一致 phone | string | number | 类型不一致,实际返回数字,前端展示需转字符串 isVip | boolean | boolean | 一致 lastLoginAt | string | null | 实际为空,文档未标明可空 address.city | string | string | 一致 address.detail | string | 缺失 | 文档有但返回中没有,影响地址展示 extraTag | 未定义 | string | 多出字段,文档未定义,暂不影响展示 结论:重点核对 phone 类型转换、address.detail 缺失和 lastLoginAt 可空处理;多出的 extraTag 暂不影响页面展示。 注:结论由持证人员核对后才能用。

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