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

核对接口文档和前端字段

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

文档和代码字段逐项对,不一致一次列清。接口字段一致性核对是把前端请求/响应字段和接口文档逐项比对;在 GPT中文网点选几项,能直接拿到字段对照表和不一致项清单。

能拿到什么

  • 推荐:前后端字段对照表+不一致项清单(一张字段对照表加一页不一致项,标出缺失、类型、命名问题)

要你点选的几项

上传接口文档、上传前端代码文件、核对范围、以哪边为准、重点看的问题、命名风格、补充信息。多数点一下就行,没选的按常见情况替你定,交付时说清哪几项是按默认的。

怎么办

  1. 上传接口文档和前端代码文件
  2. 勾选核对范围与重点问题类型
  3. 指定以文档还是代码为准
  4. 生成字段对照表和不一致项清单
  5. 按清单逐条确认改文档还是改代码

别人还这样说

  • 帮我把这份接口文档和前端请求代码里的字段对一遍,看哪里对不上。
  • 前端传的参数名和文档不一样,给我列个表,标出不一致的地方。
直接说你要办的事。下面是别人怎么办的,点任何一项就换成你自己的。左边是别人怎么办的,右边是你的,点一项就开始改。
示范 · 别人这样说

「接口字段有没有缺失、类型不对的,出一份清单我拿去改。」

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

你的成品会在这里出现
示例成品 · 不是你的按示范写的,看个样子
示例:接口字段一致性核对报告(示意) 一、核对概况 文档:用户中心接口文档 v2.3(示意版本);代码:src/api/user.js(示意路径);核对范围:请求参数+响应字段;重点类型:缺失、类型不符、命名不一致。 二、前后端字段对照表 接口 | 字段 | 文档类型 | 代码类型 | 文档必填 | 代码是否必传 | 结论 GET /user/detail | userId | string | number | 是 | 是 | 类型不符 GET /user/detail | userName | string | string | 是 | 是 | 命名不一致(文档 userName,代码 username) POST /user/update | mobile | string | string | 否 | 是 | 必填不一致 POST /user/update | email | string | 未出现 | 否 | 否 | 缺失(代码未传) POST /user/update | profile.avatar | string | profile.avatarUrl | 否 | 否 | 嵌套层级差异+命名不一致 GET /user/list | pageSize | number | number | 是 | 是 | 一致 GET /user/list | list[].id | number | string | 是 | 是 | 类型不符 三、不一致项清单 1. GET /user/detail 的 userId:文档为 string,代码按 number 传,需确认后端接收类型。 2. GET /user/detail 的 userName:文档 userName,代码 username,建议统一为文档写法。 3. POST /user/update 的 mobile:文档非必填,代码设为必传,请确认是否应改文档。 4. POST /user/update 的 email:文档有、代码未传,确认是否仍需要该字段。 5. profile.avatar 与 profile.avatarUrl:层级和名称都不同,需对齐后改一边。 6. GET /user/list 的 list[].id:文档 number,代码按 string 处理,注意列表渲染和比较逻辑。 四、待人工确认 以上结论由工程师持证/负责人员核对后才能用于联调和发布;哪边为准需与后端确认。

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