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

整理接口变更对比表

关于「整理接口变更对比表」:能拿到什么、要点选什么、怎么办

传两个 OpenAPI 文件,5 分钟拿到接口变更对比表。输入新旧两版OpenAPI 3.0 JSON文件,AI自动比对并生成接口、请求参数、响应字段、HTTP状态码的增删改差异表。不替代人工评审,不提供迁移代码。

能拿到什么

  • 推荐:一份排好版的接口变更对比 Excel,按变更类型分组,含接口路径、方法、差异项和详情(Excel 表格,按新增/删除/修改分组,每行一个差异项,路径和方法分列),约 5 分钟
  • 旗舰:接口变更对比表 Excel、变更摘要 Markdown、影响接口清单

要你点选的几项

比对范围、变更粒度、上传旧版OpenAPI、上传新版OpenAPI、关注哪些变更、如何判定修改、是否标记影响、补充说明、表格排序、补充对照材料、要刷接口文档、交付格式。多数点一下就行,没选的按常见情况替你定,交付时说清哪几项是按默认的。

怎么办

  1. 上传旧版 OpenAPI JSON
  2. 上传新版 OpenAPI JSON
  3. 勾选要关注的变更维度
  4. 下载对比表格

别人还这样说

  • 这里有两个版本的OpenAPI JSON文件,帮我对比一下接口差异,列个表。
  • 帮我看看这两个OpenAPI文件差在哪
直接说你要办的事。下面是别人怎么办的,点任何一项就换成你自己的。左边是别人怎么办的,右边是你的,点一项就开始改。
示范 · 别人这样说

「把新版和旧版API的变更点整理出来,包括新增、删除和修改的字段,生成报告。」

替他选了:全部接口 · 接口级 · 新增接口、删除接口、请求参数增删改、响应字段增删改 · 字段名+类型不同即算改 · 按变更类型分组

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

你的成品会在这里出现
示例成品 · 不是你的按示范写的,看个样子
| 变更类型 | 接口路径 | 方法 | 差异项 | 详情 | |---|---|---|---|---| | 新增 | /api/v2/users/{id}/roles | POST | 请求体字段 | 新增role_type(string, required)| | 修改 | /api/v2/users | GET | 响应字段 | users[].status 枚举值新增 'pending_invitation' | | 删除 | /api/v2/users/activate | POST | 整个接口 | 已下线,由 /api/v2/users/{id}/activate 替代 |

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