当前位置： 首页 > article >正文

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

article 2025/3/1 15:59:46

目录

    • 1 安装 Apifox Helper 插件
    • 2 获取 Apifox 的 API 访问令牌
    • 3 IDEA 中设置 API 访问令牌
    • 4 IDEA 中上传接口
    • 5 常见问题
      • 5.1 如何自动设置目录名
      • 5.2 如何自动设置接口名
      • 5.3 如何更改上传位置

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 的 设置，红框中的内容即为之前设置的上传位置：

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

在这里插入图片描述




http://www.kler.cn/a/455757.html

相关文章：

  • linux自动化一键批量检查主机端口
  • Ruby 数据库访问 - DBI 教程
  • 内网DNS解析 (PrivateZone）
  • 洪水灾害多智能体分布式模拟示例代码
  • 大数据存储ZNS，缘起与进化：Open-Channel SSD到ZNS的发展
  • mysql-二进制安装方式
  • 平安夜与圣诞节，如何玩转节日选题？
  • 20241227解决使用向日葵远程工具连接ubuntu20.04.5出现黑屏的问题
  • 两个控制器NTP/ptp时间同步
  • UE（虚幻）学习（四） 第一个C++类来控制小球移动来理解蓝图和脚本如何工作
  • 使用Python实现智慧城市数据平台：走向未来的智能城市管理
  • 如何使用Python和PIL库生成带竖排文字的封面图像
  • IS-IS（Intermediate System to Intermediate System）
  • Peter Lax线性代数教材：Linear Algebra and Its Applications 2nd Ed
  • vue3项目使用scss报错相关处理
  • 使用Vue+Django开发的旅游路书应用
  • 专业版pycharm与服务器连接
  • HarmonyOS Next 应用元服务开发-应用接续动态配置迁移按需退出
  • 关于uni-forms组件的bug【提交的字段[‘*‘]在数据库中并不存在】
  • [Unity Shader][图形渲染] Shader数学基础11 - 复合变换详解