Apifox IDEA 插件 | 帮助开发者快速生成 API 文档

Bertha 。 2024-03-26 11:23 69阅读 0赞

Apifox 已推出 IDEA 插件 「Apifox Helper」 。**Apifox Helper 是一款集成在 IDEA 中，帮助开发者自动解析代码注解并快速生成 API 文档的便捷工具。** Apifox Helper 是基于 javadoc（Java）、KDoc（Kotlin）、ScalaDoc（Scala）解析 API 文档，支持 Spring Boot、Swagger、JAX-RS 等协议框架，基本可以实现**代码零入侵自动生成接口文档**。

![768b3c3f34dafcad98bb59e5d72eba0c.png][]

在 IDEA 中使用 Apifox Helper 可以一键同步文档到 Apifox 项目中，开发者无需切换工具，即可更新同步文档给团队内其他人员。自动解析注解、快速同步文档、IDEA 内调试、Apifox 便捷团队协作，你只需一个「Apifox Helper」。

接下来给大家演示如何使用。

**安装 & 配置**

首先，需要在 IntelliJ IDEA 安装并且配置令牌。打开 Preferences(Settings) > Plugins ，搜索 Apifox Helper 点击安装即可。

你也可以从 Jetbrains Marketplace 的官网下载安装。

![6d172eecf254d820dd336f13fb3b3062.png][]

安装成功后，要将 IDEA 内的项目与 Apifox 的项目进相关联，需要配置令牌。进入设置界面 Preferences(Settings) > Apifox Helper 中填写 Apifox 服务器地址、个人访问令牌、项目 ID：

1.  **Apifox 服务器地址**：默认 Apifox API 服务地址为 \*https://api.apifox.cn\*，无需修改。
2.  **Apifox 个人访问令牌**：在 Apifox 个人头像处的「账号设置 --> API 访问令牌」，新建令牌后复制生成的 Token 填写即可。
3.  **模块项目 ID 配置**：这项主要是进行代码模块名和项目 ID 的映射关系配置，在 Apifox 中进入项目中「项目设置 --> 基本设置」，复制项目 ID 粘贴过来。

![12cef7b81cba7836fee8fbaf154cb17c.png][]

完成以上配置操作，就可以实现文档自动生成、同步、在线调试、导入导出等功能了。

**自动生成 API 文档**

使用「Apifox Helper」可直接自动解析代码注解，代码零入侵。**右键点击「 Upload to Apifox」即可生成完整的 API 文档并同步到 Apifox 项目中** **，无需导出操作**。团队成员即可在 Apifox 项目中完成接口调试、自动化测试等工作。

![5ca2582f0b5cdf315f2833de02479609.png][]

**接口信息一键更新同步**

当在 IDEA 项目中有接口信息变动，**只需右键点击「 Upload to Apifox」一键即可完成同步，** 无需奔走相告。团队成员可在 Apifox 中看到同步后的最新内容。

![6f1038fba48b67142cac1e8157df930d.png][]

此外，使用 Apifox Helper 可以在 IDEA 中**一键发起接口内测**，同时支持**导出 Markdown 格式文档和 cURL**，适应不同团队的协作方式。

结合 IDEA 插件，我们推荐代码先行的团队 API 协作实践方式如下：

*  **后端开发者**：在 IDEA 中安装 「Apifox Helper」，随时编写/调试，随时更新同步；
 *  **前端开发者**：在 Apifox 中查看最新文档，进行接口调试、API Mock ；
 *  **测试工程师**：在 Apifox 中获取最新接口信息，编写/保存测试用例、进行自动化测试。

让后端开发者只需一个「Apifox Helper」即可在 IDEA 中完成 API 协作所需的工作。

![56a8801d02f07b5383779cd288b205c7.png][]

现在出发，\*\*在 IDEA 内 「plugin」入口搜索「Apifox Helper」\*\*下载试试吧！

想了解更多关于插件的内容可以**前往 Apifox 官方帮助文档查看**。

[768b3c3f34dafcad98bb59e5d72eba0c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/5a9a1bb75d35481eab807efb91550552.png
[6d172eecf254d820dd336f13fb3b3062.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/5afef9fbc1774c9eb82c95a74e24642c.png
[12cef7b81cba7836fee8fbaf154cb17c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/c62845c0d93449a1b551cc090bc74322.png
[5ca2582f0b5cdf315f2833de02479609.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/c635d4cabfa94803af75d7a2f756b943.png
[6f1038fba48b67142cac1e8157df930d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/ed92114be2b940769d9ffd514b30e7b3.png
[56a8801d02f07b5383779cd288b205c7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/e6fedf6619eb484ab15577c9b52247c5.png