Apifox IDEA 插件
  1. 快速上手
Apifox IDEA 插件
  • 快速上手
    • 介绍
    • 安装
    • 实战使用
    • 获取访问令牌
    • 获取项目 ID
    • 导出API
    • 常见问题 FAQ
  • 配置
    • 如何使用配置？
    • 使用项目内配置文件
    • 其他
    • 配置文档
  • 进阶使用
    • 注释规范说明
    • 框架支持
    • 支持的回调--暂不用
  1. 快速上手

实战使用

基础配置#

安装插件后，进入设置界面 Preferences(Settings) > ApifoxUploader
image.png
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

同步接口到 Apifox#

同步模块内所有接口#

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

同步 controller 文件内所有接口#

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

同步选择部分接口#

在模块目录上或代码编辑区域的右键菜单中选择 Export API
image.png
选择想要同步的单个或部分接口，回车执行同步请求
image.png
修改于 2022-12-14 09:45:36
上一页
安装
下一页
获取访问令牌
Built with