告别“裸奔”的字段:我用 Apifox AI,1分钟完善了整个旧项目的数据模型

51 阅读3分钟

你是否也接手过这样的“屎山”项目?

项目文档残缺不全,数据模型里全是 namedatastatus 这种“猜谜式”字段。没有中文名,没有描述,更别提 Mock 规则了。下游的前端和测试同事怨声载道,而你,作为“接盘侠”,不得不花上一下午的时间,去逐个字段添加注释和 Mock 规则。

这个过程,枯燥、重复,且毫无技术含量。如果... 有个助手能帮我们搞定这一切就好了。

解决方案介绍 (功能亮相):

现在,这个助手来了!Apifox AI 功能已正式集成到数据模型模块中。

它就像一个内置在你工作流中的“数据模型专家”,你可以通过聊天的方式,让 AI 帮助你高效地完善(甚至重构)任何复杂的数据模型。

准备工作:激活你的 AI 助手

在使用之前,我们需要先“唤醒”它。Apifox 提供了免费的 AI 功能框架,但你需要接入自己的“大脑”(AI 模型)。

  1. 检查版本:确保你的 Apifox 客户端版本 2.7.37\ge 2.7.37
  2. 启用 AI:在设置中,手动找到并「启用 AI 功能」。
  3. 配置 Key:添加你自己的 AI 模型(例如 OpenAI, Kimi, 或其他兼容模型)并配置对应的 API Key。

89fce60a880428869a24124629ee39d5_image-preview_onlineShareType=apidoc&locale=zh-CN.png 详细操作指南 (How-To Guide):

假设我们现在面对一个“裸奔”的用户模型(User),它只有基础字段名。

步骤一:唤醒 AI 助手

在 Apifox 的「接口文档」或「数据模型」页面,找到你需要修改的数据模型。将鼠标悬停在模型区域(例如 properties 旁),你会看到一个新增的 AI 图标

image.png

步骤二:进入 AI 对话

点击这个 AI 图标,一个全新的弹窗会打开。

  • 左侧:显示的是你当前的数据模型(JSON 结构)。
  • 右侧:就是你的 AI 助手聊天界面。

5d0839fa59d6ac15da8a0a1cad832ed2_image-preview_onlineShareType=apidoc&locale=zh-CN.png

步骤三:下达“魔法指令”

现在,神奇的时刻到了。你不需要自己动手改左侧的 JSON。

你可以在右侧的聊天框里输入:“请帮我为所有字段添加中文名、详细描述,并生成 Mock 规则。

或者,直接点击我们为你准备好的快捷指令,例如:「添加中文名和描述」。

994db608612ff56a30d971e86358ea4f_image-preview_onlineShareType=apidoc&locale=zh-CN.gif

步骤四:审查与应用

AI 会立刻在左侧的 JSON(草稿)中生成所有内容。比如,它会自动识别 username 并添加中文名“用户名”,识别 email 并添加 @email 的 Mock 规则。

最棒的是,你还可以在这个弹窗中直接手动修改 AI 生成的内容,进行最后的微调。

确认无误后,点击右下角的「应用」按钮。

3c05fe9da1aaaa3b330f84163aafe576_image-preview_onlineShareType=apidoc&locale=zh-CN.png

结果展示:

瞬间,你那“惨不忍睹”的数据模型变得焕然一新——注释清晰、Mock 完备。过去需要一小时的体力活,现在 1 分钟搞定。

总结

不要再把时间浪费在重复的文档维护上了。立即更新你的 Apifox,配置好 AI 助手,体验“一句话搞定数据模型”的快感吧!