使用ApiFox进行接口管理

原创已于 2025-10-29 16:05:30 修改 · 2.9k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#java

于 2024-05-08 14:57:50 首次发布

在系统开发过程中，前后端经常需要一起联调，一次一个统一的接口管理系统就显得十分重要，这里介绍一下使用ApiFox进行接口管理的过程。

后端开发工具使用IDEA，前端开发使用VSCODE，接口管理工具使用ApiFox。

注册ApiFox

首先访问ApiFox官网https://app.apifox.com/user/login，使用微信扫码登录即可。

然后依次新建团队和项目，点击项目后进入界面如下：

配置IDEA

IDEA安装ApiFox插件ApiHelper，安装完成后在Setting中选择公网SaaS

API访问令牌在ApiFox中账号设置中拷贝即可

然后在IDEA中只需要将对应的Controller注释写完整，就可以直接将接口上传到ApiFox网站

在Controller类中右键鼠标，选择Upload to Apifox即可。Apifox提供桌面端工具，接口上传后效果如下

接口测试

一般系统除了登录认证接口，访问其他接口一般需要认证信息，但是一般这是两个接口，因此，需要在两个接口之间将认证信息进行传递。因此可以编写接口后置脚本，比如这里认证接口编写后置脚本如下图所示

const accessToken = "Bearer " + pm.response.json()['token'];
pm.environment.set("auth", accessToken);
console.log(accessToken);

然后在调用其他接口时，先调用一下这个认证接口，将认证信息写入环境变量，然后执行其他接口时在Header中加入这个环境变量，如下图所示

其它

Postman也有类似的方式，增加后置脚本

var result = JSON.parse(responseBody);
if (result.token) {
    pm.environment.set('access_token', result.token);
    pm.globals.set("access_token", result.token);
    postman.setEnvironmentVariable("access_token", result.token);
    console.log('Token >> ', result.token);
}

多级目录

1、在工程根目录下增加.apifox-helper.properties文件，内容如下：

folder.name=#folder
api.name=#name

2、在对应的接口上增加相应的注释

/**
 * 用户相关接口
 * @author ：admin
 * @folder 用户微服务/用户模块
 * @time Created in 2025/6/19 15:01
 * @description：用户相关基础功能
 */
@RestController
@RequestMapping("/user")
@Slf4j
public class UserController extends BaseController {

    @Autowired
    private UserService userService;

    /**
     * 获取用户列表
     * @param bo
     * @return
     */
    @PostMapping("/page")
    public ResultBody<IPage<User>> page(@RequestBody UserBO bo)  {}
}