介绍

Apifox Helper是Apifox官方开发的一个IntelliJ IDEA插件,可以根据Controller层的接口方法快速在Apifox中自动生成接口文档,以进行接口测试

Apifox的官网地址:Apifox - API 文档、调试、Mock、测试一体化协作平台

使用文档:帮助中心 | Apifox 使用文档

使用

生成API访问令牌

根据下图生成一个访问令牌,该令牌只有在创建时才能看到,所以要保管好,不然忘记了就只能再重新新建一个

image-20230219110842615

获取项目ID

打开新建的项目,根据下图获取项目的ID

image-20230219111344880

配置Apifox Helper

打开IntelliJ IDEA的设置后,根据下图配置Apifox Helper,模块项目ID配置可以有多个

image-20230219111904041

生成接口文档

  1. 生成一个类的某个方法的文档

    image-20230219115851243

  2. 生成一个类的全部方法的文档

    image-20230219115931777

  3. 生成多个类的全部方法的文档

    image-20230219115955359

配置Apifox请求的前置URL

打开项目后,根据下图配置请求的前置URL,这样每次请求都会自动加上了

image-20230219120607584