1、安装
1.1 Apifox安装
官方文档:Apifox - API 文档、调试、Mock、测试一体化协作平台 - 接口文档工具,接口自动化测试工具,接口Mock工具,API文档工具,API Mock工具,API自动化测试工具
1.2 IDEA 插件安装
打开 IDEA > Preferences(Settings) > Plugins ,搜索 Apifox Helper
![](https://img-blog.csdnimg.cn/fc57df8f323b48a6a6f459659c9fa109.png)
2、Apifox配置
2.1 创建团队
![](https://img-blog.csdnimg.cn/495d3b6a6cef4b89ab21e7b09a8283e4.png)
2.2 创建项目
![](https://img-blog.csdnimg.cn/f7c7e2a9b60d4d5ea4a976966fa2585a.png)
![](https://img-blog.csdnimg.cn/7debb9dbdb4c4416be8eefb5b159f45c.png)
3、idea配置
官方地址:Apifox IDEA 插件快速上手 | Apifox 帮助文档
3.1 获取项目 ID
打开项目设置——基本设置,复制项目 ID
![](https://img-blog.csdnimg.cn/e26b7339b7b84c29857ef5f6ac55d658.png)
3.2 获取访问令牌
Apifox 个人访问令牌:获取访问令牌
![](https://img-blog.csdnimg.cn/302da16ee0854a82b9dda2c62dcf61b6.png)
复制令牌
![](https://img-blog.csdnimg.cn/4761c89bea7c4ecd910fb3817a848bb6.png)
3.3 idea配置
安装插件后,进入设置界面 Preferences(Settings) >Other Setting> ApifoxHelper
![](https://img-blog.csdnimg.cn/2ec8d3e3307e490982e9f04d025bb868.png)
框架配置
针对特定框架,Apifox
插件支持选择远程配置和添加自定义的远程配置 URL。
![](https://img-blog.csdnimg.cn/1753200fdd7c4200b429f18d7774a39f.png)
3.5 同步接口到 Apifox
3.5.1 同步模块内所有接口
在模块目录上的右键菜单中选择 Upload to Apifox
![](https://img-blog.csdnimg.cn/dc1a1e61bded4ffa9b8e30bbf255f738.png)
再次输入项目id
![](https://img-blog.csdnimg.cn/67fb9447607249ad85b546931494a39d.png)
apifox中刷新,就可以看到生成的接口了。
![](https://img-blog.csdnimg.cn/15a4e5cc07574e30bb09433a466e7d35.png)
3.5.2 同步 controller 文件内所有接口
在代码编辑区域的右键菜单中选择 Upload to Apifox
![](https://img-blog.csdnimg.cn/230f70c4c6984afb86b5d24c6b37a117.png)
3.5.3 同步选择部分接口
- 在模块目录上或代码编辑区域的右键菜单中选择
Export API
- 选择想要同步的单个或部分接口,回车执行同步请求
4、分享
![](https://img-blog.csdnimg.cn/c5920867c8254b5ba5b72b8373d2d574.png)
![](https://img-blog.csdnimg.cn/35e377c86813474ab5ef9af2484f6364.png)
查看链接地址
5、接口配置
5.1 官方文档
官方文档:常见问题 FAQ | Apifox 帮助文档
注释规范:注释规范说明 | Apifox 帮助文档
5.2 示例
![](https://img-blog.csdnimg.cn/028bc6075b1f4329a2a991d6bbdb0ebe.png)