IDEA | SpringBoot 项目中使用 Apifox 上传接口

---

Apifox 官方指南：

• https://apifox.com/help/applications-and-plugins/idea/start

1 安装 Apifox Helper 插件

打开 IDEA 的设置，搜索并安装 Apifox Helper 插件:

2 获取 Apifox 的 API 访问令牌

进入 Apifox 网页，点击右上角的 设置：

选择 API 访问令牌，并点击 新建：

请自行设置 名称 和 有效期：

点击 保存并生成令牌 后，记得及时复制生成的令牌，关闭该弹窗后将永远无法查看：

3 IDEA 中设置 API 访问令牌

回到 IDEA 的 设置 中，进入 Apifox Helper 选项卡。

把刚才生成的令牌粘贴过来，然后点击 测试令牌：

4 IDEA 中上传接口

进入 Controller 文件中，鼠标右键后点击 Upload to Apifox：

这一操作会将当前 Controller 中的所有接口上传到 Apifox 中。

如果是第一次上传接口，那么会弹出一个弹窗，它要求我们选择接口的上传位置。后续都将使用这个上传位置：

这些候选位置来源于我们在 Apifox 中创建的团队、项目和目录。

上传结束后 IDEA 的终端会显示运行结果：

5 常见问题

5.1 如何自动设置目录名

上传前在 Controller 文件的最前面写上注释：

5.2 如何自动设置接口名

上传前给方法写上注释，否则 Apifox Helper 会直接使用方法名作为接口名：

5.3 如何更改上传位置

打开 IDEA 的 设置，红框中的内容即为之前设置的上传位置：

• 要么直接对该记录进行修改；
• 要么删除该记录，下次上传时会重新弹出弹窗让我们设置上传位置。