Apifox IDEA 插件快速上手

介绍

Apifox IDEA 插件（Apifox Helper） 主要用于 IDEA 项目快速生成 API 文档，并同步到 Apifox，代码零入侵。

• 基于 javadoc（Java）、KDoc（Kotlin）、ScalaDoc（Scala） 解析 API 文档。
• 支持 Swagger 注解
• 注意：可以在保持代码零侵入的情况下得到相当完整的 API 文档，但是特殊的需求还是需要部分特殊的注释/注解配合，注释规范说明。
• 该插件基于 easy-api 定制开发，感谢 easy-api 作者

功能特性

• 导出 API 文档到 Apifox
• 导出 Markdown 格式 API 文档
• 在 IDEA 中直接发起 API 请求

支持项列表

	默认支持	额外(配置)支持
语言	java, kotlin	scala
web	spring, feign, jaxrs (quarkus / jersey)	dubbo
常用框架	javax.validation, Jackson, Gson	swagger

安装

支持以下 IDE

• IntelliJ IDEA 193.+(2019.3+)
• IntelliJ IDEA Community Edition 174+(2017.4+)

从 Jetbrains Marketplace 官网安装

从 IDEA plugins 中搜索安装

• 打开 IDEA > Preferences(Settings) > Plugins ，搜索 Apifox Helper

手动下载安装

• 下载插件：下载地址
• Preferences(Settings) > Plugins > Install plugin from disk...
• 重启 IDE

获取项目 ID

打开项目设置——基本设置，复制项目 ID

获取访问令牌

Apifox 个人访问令牌：获取访问令牌

基础配置

安装插件后，进入设置界面 Preferences(Settings) > ApifoxHelper

• Apifox 服务器地址: 填写 Apifox API 服务地址，SaaS 版默认为 https://api.apifox.cn
• Apifox 个人访问令牌：获取可参考文档获取访问令牌
• 模块项目 ID 配置: 代码模块名和项目 ID 的映射关系配置，其中项目 ID 的获取可参考文档获取项目 ID

模块项目 ID 配置:

每个 Module 都需指定一个项目 ID，可选指定目标目录名。

• 如下填写，表示的是 mall-admin 和 mall-search 模块都导入到项目 2051427 且都是导入到根目录。

mall-admin:2051427
mall-search:2051427

• 如下填写，表示的是 mall-admin 和 mall-search 模块都导入到项目 2051427，分别导入到 管理后台、搜索目录下。

mall-admin:2051427,管理后台
mall-search:2051427,搜索

• 多级目录用/分割，如下填写，表示的是 mall-admin 和 mall-search 模块都导入到项目 2051427，分别导入到商城/后台管理、商城/商城搜索目录下。

mall-admin:2051427,商城/后台管理
mall-search:2051427,商城/商城搜索

框架配置

针对特定框架，Apifox插件支持选择远程配置和添加自定义的远程配置 URL。

同步接口到 Apifox

同步模块内所有接口

• 在模块目录上的右键菜单中选择 Upload to Apifox

同步 controller 文件内所有接口

• 在代码编辑区域的右键菜单中选择 Upload to Apifox

同步选择部分接口

• 在模块目录上或代码编辑区域的右键菜单中选择 Export API

• 选择想要同步的单个或部分接口，回车执行同步请求

常见问题

• 常见的一些使用场景，如 怎么设置接口 API 所属文件夹的名称 、 如何添加配置文件、 如何增加外层的公共返回响应 Response 泛型 、 如何适配 Mybatis Plus 工程的分页 Page 模型和请求参数 ，参考常见问题文档
• 自定义配置，参考配置文档

联系我们

有关 IDE 插件的问题，请加下方微信（备注：IDEA），进内测群沟通交流