Apifox IDEA 插件使用指南 - 从入门到精通（1）

引言

作为一名长期使用 Apifox Helper 的开发者，我可以说是一路见证了这款插件的成长与完善。从最初的功能雏形到如今的强大工具，Apifox Helper 在不断地迭代中变得越来越好用，也逐渐成为了我日常开发中不可或缺的助手。
然而，尽管我已经使用 Apifox Helper 很久了，却一直没有时间系统地总结一下自己的使用心得。趁着现在有时间，我决定静下心来，写一些关于如何高效使用这款插件的文章。希望通过我的经验分享，能够帮助到那些对 Apifox Helper 感兴趣的小伙伴，让大家少走弯路，更快地上手这款强大的工具。话不多说直接上手

1. 如何安装Apifox Helper

安装 Apifox Helper 非常简单，以下是两种常见的安装方式：

方式一：通过 IntelliJ IDEA 插件市场安装

• 打开 IntelliJ IDEA，进入 Settings（Windows/Linux）或 Preferences（macOS）。
• 选择 Plugins，然后点击 Marketplace。
• 在搜索框中输入 Apifox Helper，找到插件后点击 Install 即可完成安装。
  

方式二：通过 IntelliJ IDEA 插件官网下载安装

• 访问 IntelliJ IDEA 插件官网。
• 搜索 Apifox Helper，找到插件后下载对应的 zip 安装包。
• 返回 IntelliJ IDEA，进入 Settings/Preferences -> Plugins。
• 点击右上角的齿轮图标，选择 Install Plugin from Disk，然后选择下载的 zip 文件即可完成安装。
  
  

注意事项

Apifox Helper 目前提供了两个版本后缀：

• 193：兼容 IntelliJ IDEA 2019.3 到 2024.3 版本。
• 243：兼容 IntelliJ IDEA 2024.3 及之后的版本。

在下载时，请根据你的 IntelliJ IDEA 版本选择合适的插件版本，以确保兼容性。

2. 如何快速配置Apifox Helper

安装 Apifox Helper 后，首先需要配置身份信息，以便插件能够与 Apifox 平台进行交互。以下是详细配置步骤：

2.1 申请 Token

• 打开 Apifox 软件本体。
• 点击右上角的齿轮图标，进入设置页面。

• 在设置页面中，找到 API 访问令牌 选项。

• 点击 新建，创建一个新的访问令牌。
• 在有效期选项中，选择 无期限（适合长期使用）。
• 点击 保存并生成令牌，系统会自动生成一个 Token。

2.2 配置 Apifox Helper 并校验 Token

在成功生成 Token 后，接下来需要在 IntelliJ IDEA 中配置 Apifox Helper，并校验 Token 是否有效。以下是详细步骤：

2.2.1

1. 打开 IntelliJ IDEA，进入 Settings/Preferences。
2. 在左侧菜单栏中，找到并点击 Apifox Helper 选项（安装成功后，它会出现在第一栏）。
3. 进入 Apifox Helper 的配置页面。
   

2.2.2 上传 API 访问令牌

1. 在配置页面中，找到 API 访问令牌 输入框。
2. 将之前生成的 Token 粘贴到输入框中。

2.2.3 校验令牌

1. 点击 校验令牌 按钮，系统会自动验证 Token 的有效性。
2. 如果 Token 校验成功，页面会提示 成功，表示配置已完成。

2.2.4 常见的令牌校验失败问题及解决方法

在使用 Apifox Helper 时，可能会遇到令牌校验失败的情况。以下是几种常见问题及其解决方法：

1. 权限问题

• 如果是没有权限，检查一下自己的权限
• 如果权限不足，请联系团队管理员或项目负责人，申请相应的权限。

2. 网络连接超时

• Token 校验失败，提示网络连接超时。
• 如果你在使用破解版 IntelliJ IDEA 时配置了代理，可能会导致网络连接问题。
• 打开 IntelliJ IDEA 的 Settings/Preferences，在搜索栏中输入 HTTP Proxy
• 将代理设置为 No proxy，或者确保你的代理服务器已将 Apifox 的相关域名加入白名单。
  

3. 自定义代理配置

• Apifox Helper 支持自定义代理端口，方便开发者调试网络请求。
• 使用抓包工具（如 Charles）监控网络请求，查看返回结果，定位问题根源。
• 根据抓包结果，调整代理配置或检查网络环境。

3. 熟悉 Apifox Helper 的核心功能

完成基本配置后，接下来我们将深入了解 Apifox Helper 的核心功能。这些功能不仅简单易用，还能极大提升你的 API 开发效率。以下是主要功能的详细介绍：

3.1 识别 API 并上传到 Apifox

• 功能描述：Apifox Helper 可以自动识别项目中的 API 定义，并将其上传到 Apifox 平台。

3.1.1 批量上传所有 API

• 在 IntelliJ IDEA 中，打开包含 API 定义的代码文件或文件夹。
• 右键点击代码，选择 Upload to Apifox 上传当前选中状态的所有 API 。
  

3.1.2 选择性上传 API

• 在 IntelliJ IDEA 中，选择 Apifox Helper -> Export API。
• 此时会弹出一个选择窗口，列出所有可上传的 API。
• 勾选你需要上传的 API，然后点击确认。
  

3.1.3 右键生效范围

• 文件目录：右键点击目录，上传该目录下的所有 API。
• 文件：右键点击单个文件，上传该文件中的所有 API。
• 文件窗口：在代码编辑窗口中右键点击，上传当前文件中的 API。
  

3.2.1 上传完成后的目录选择

在上传 API 完成后，系统会提示你选择目标目录。这是一个关键的知识点：这里的模块对应 Java 项目中的模块。具体来说：

• 你选择的模块下的所有 API 将会上传到 Apifox 中指定的文件夹。

• 该文件夹将成为这些 API 的根目录，与其他文件夹完全独立，互不影响。

• 适合多模块项目，确保每个模块的 API 独立管理。
  
  在上传 API 时，Apifox Helper 会提示你选择两个目录：接口目录 和 数据模型目录。以下是详细说明：

• 上传完成后，系统会弹出一个目录选择窗口。

• 在 Apifox 的目录树中，选择目标文件夹作为接口的根目录。

• 例如，你可以选择 个人测试团队 -> 测试项目 -> javaxController 作为接口目录。

• 确认后，所有 springTest 项目下的 API 接口都会上传到该目录下。

• 选择完接口目录后，需要选择数据模型目录

• 在 Apifox 的目录树中，选择目标文件夹作为数据模型的根目录。

• 确认后，所有与 API 相关的数据模型都会上传到该目录下。

3.3.1 上传完成后的结果反馈

需要关注的数据

• Created : 创建数量
• Updated : 更新数量
• Ignored : 忽略数量
• Failed : 失败数量
• Endpoints : 接口数量
• Schemas ：数据模型数量
  

3.4.1 修改模块上传目录

在某些情况下，你可能需要将某个 API 模块的目录调整到其他文件夹或项目中。以下是修改模块上传目录的具体步骤：
1. 进入配置页面

• 打开 IntelliJ IDEA，进入 Settings/Preferences。
• 在左侧菜单栏中，找到并点击 Apifox Helper。
• 选择 上传到 Apifox Helper 选项卡。

2. 修改模块与项目的对应关系

• 在配置页面中，找到 代码模块与 Apifox 项目对应关系 的设置项。
• 这里会列出所有已配置的模块及其对应的 Apifox 目录。
• 找到需要修改的模块，点击编辑按钮（通常是一个铅笔图标）。
• 在弹出的窗口中，选择新的目标文件夹或项目。
• 保存修改。

3. 保存并应用

• 修改完成后，点击 Apply 或 OK 保存配置。

3.2 在 IDEA 内部调试 API

Apifox Helper 提供了强大的内置调试功能，让你无需离开 IntelliJ IDEA 即可完成 API 调试。以下是具体的使用方法：

• 在 IntelliJ IDEA 的右侧工具栏中，点击 Apifox 图标 。此时会弹出一个右侧窗口，分为上下两部分：

• 上半部分：显示当前项目的所有 API，以目录树的形式组织。

• 下半部分：调试面板，用于发送请求并查看响应结果。

快速定位 API 接口，在 IntelliJ IDEA 的代码编辑器中，找到包含 API 定义的代码段。选中该代码段后，左侧会显示一个 API 图标。点击该图标。

3.3 识别 API 并导出文档与数据模型

Apifox Helper 不仅支持 API 调试和上传，还提供了强大的文档导出功能。你可以将 API 导出为 Markdown 文档，或将数据模型导出为 JSON、JSON5、Properties 等格式。以下是具体的使用方法：

1. 导出 Markdown 文档
功能描述：将 API 定义导出为 Markdown 格式的文档，方便编写技术文档或与团队成员共享。
操作步骤：

• 在 IntelliJ IDEA 中，右键点击包含 API 定义的代码文件或文件夹。
• 选择 Apifox Helper -> Export Markdown。

2. 导出数据模型（JSON/JSON5/Properties）
功能描述：将数据模型（如请求/响应数据结构）导出为 JSON、JSON5 或 Properties 格式。
适用范围：该功能仅在 Class 文件中生效，用于解析数据模型，而非 API。
操作步骤：

• 在 IntelliJ IDEA 中，右键点击包含数据模型的 Class 文件。
• 选择 Apifox Helper -> TO JSON、TO JSON5 或 TO Properties。
• 选择保存路径，生成对应格式的文件。

4. 总结

本文详细介绍了 Apifox Helper 这款 IntelliJ IDEA 插件的核心功能和使用方法，帮助你高效管理 API 开发流程。以下是主要内容回顾：

1. 安装与配置：

• 通过 IntelliJ IDEA 插件市场或官网下载安装 Apifox Helper。
• 配置 API 访问令牌，确保插件与 Apifox 平台的连接。

2. API 上传与目录管理：

• 支持批量上传和选择性上传 API。
• 灵活选择接口目录和数据模型目录，满足多模块项目的需求。
• 通过控制台查看上传结果，快速定位问题。

3. 内置调试功能：

• 在 IDEA 内直接调试 API，无需切换工具。
• 通过目录树快速定位 API，并填充调试参数。

4. 文档与数据模型导出：

• 将 API 导出为 Markdown 文档，方便编写技术文档。
• 将数据模型导出为 JSON、JSON5 或 Properties 格式，便于数据共享。