【好物推荐】IntelliJ IDEA 的插件推荐之Apifox Helper入门介绍

一、Apifox Helper 是什么？

Apifox Helper 是一个针对 IntelliJ IDEA 的插件。
Apifox Helper 是 Apifox 团队针对 IntelliJ IDEA 环境所推出的插件
Apifox Helper 可以在 IDEA 环境中识别本地 Java、Kotlin 后端项目的源代码，自动生成 API 文档并一键同步到 Apifox 的项目中。

Apifox Helper旨在帮助开发者自动生成 API 文档并将其同步到 Apifox 项目中。
使用 Apifox Helper 可以轻松地维护 API 文档并与团队成员共享，从而提高开发效率和协作效果。
使用 Apifox Helper 可以显著提高开发效率，因为它可以基于代码注释自动生成文档。
【好物推荐】APIFox让我感受到了接口调用的快乐

二、安装 Apifox Helper

1. 打开 IntelliJ IDEA。
2. 在主菜单中选择 File > Settings（Windows/Linux），然后选择 Plugins。
3. 点击 Marketplace 标签，搜索 Apifox Helper。
4. 从搜索结果中找到 Apifox Helper 并安装。
5. 重启 IntelliJ IDEA 以完成安装。

三、使用 Apifox Helper

3.1 设置 Apifox 访问令牌

1. 在 Apifox 中登录您的账户。
2. 进入个人设置，找到访问令牌部分，创建一个新的访问令牌。
3. 在 IntelliJ IDEA 中打开 Apifox Helper 插件设置界面，输入刚刚创建的访问令牌。

3.2 创建 Apifox 项目

1. 在 Apifox 中创建一个新的项目。
2. 记录该项目的 ID 或名称，以便稍后在 IntelliJ IDEA 中使用。

3.3 生成和同步文档

1. 在 IntelliJ IDEA 中打开您的项目。
2. 使用 Apifox Helper 插件扫描您的项目源代码。
3. 选择要生成文档的类或方法。
4. 选择或创建一个目标 Apifox 项目。
5. 点击同步按钮，插件会自动分析您的代码注释并生成相应的 API 文档。
6. 文档会自动同步到您指定的 Apifox 项目中。

3.4 更新文档

当您的代码发生变化时，只需重新运行 Apifox Helper 插件，它就会更新已有的文档或添加新的文档。

四、Apifox Helper支持的注释类型

Apifox Helper 支持以下类型的注释：

• Javadoc (Java)
• KDoc (Kotlin)
• ScalaDoc (Scala)

五、Apifox Helper支持的框架

插件支持以下常见的框架：

• Spring Boot
• Swagger
• JAX-RS

对于常见的开发框架，Apifox Helper 插件能够做到开箱即用，实现真正的代码零侵入。
如下图所示，仅通过识别最基本的 SpringBoot 代码，即可生成一份详尽的 API 文档：

六、使用Apifox Helper注意事项

• 确保您的代码中有足够的注释来描述 API，以便插件能够准确生成文档。
• 保持插件的最新版本，以获得最佳体验和最新的功能支持。