使用 APIFOX 调试 - 基础请求令牌设置

APIFOX

APIFOX 是 API 一体化协作平台,是,更先进的 API 设计/开发/测试工具。

Apifox = Postman + Swagger + Mock + JMeter。

工具官网 :  https://apifox.com/

使用 APIFOX 调试 GOCMS 接口

1 新建项目

打开工具 新建一个项目 如 GOCMS 。

2 新建接口

点击刚刚新建的项目名称,打开项目界面,左侧 接口 新建接口,如  : test。

3. 配置开发环境

打开 API 列表,点击右上角的 管理环境 选择开发环境,然后点击右侧的菜单按钮,配置开发环境 :

修改 服务( 前置 URL )为 : localhost/API 并保存。

此时运行 /Test 接口依然返回 :

此文档内容需登录 + 付费后才能查看!

因为在上一节我们已经讲过 :

API 路由中间件内封装了基础令牌检查,所有的请求都必须携带基础请求令牌并验证通过。

我们将利用 APIFOX 的请求前置操作来实现基础令牌的获取及提交。

4. 关于基础请求令牌

基础请求令牌是指所有请求都要携带的令牌,这样做可以使得整个 API 接口更加安全。

基础令牌获取及提交流程 :

4.1 有条件的获取基础令牌

默认情况下客户端第一次与API接口进行交互,并没有获得请求令牌,所以我们在前端请求过程中要先检查基础请求令牌的合理性:

4.1.1 客户端没有存储请求令牌,请求API接口获取令牌,让然后执行请求并携带令牌;

4.1.2 客户端已经存储请求令牌并且令牌在有效期内,可以进行请求(携带令牌)。

4.1.3 客户端已经存储请求令牌但令牌已经失效,重新请求API接口获取令牌,让然后执行请求并携带令牌

5. 使用 APIFOX 前置操作保证基础令牌正确性

5.1 点击接口页面 -> 右上角菜单 -> 全局变量 -> 添加 RTK 和 Tokentime 2个环境变量 :

分别用于记录基础请求令牌和基础请求令牌创建时间 :

5.2 点击 左侧下方 全局参数按钮 -> 添加一个 RTK 全局参数 ( 关联值 上面的全局变量 RTK ) :

记得保存哦 ~

5.3 点击对应接口 -> 点击前置操作 -> 添加前置操作

5.4 点击公共脚本 -> 管理公共脚本 -> 添加公共脚本 -> 脚本名称 : 基础 Token,代码如下 :

代码如下 :

此文档内容需登录 + 付费后才能查看!

5.5 再次运行 /Test 接口

如上图所示,请求成功。

注意

之后开发的所有接口都需要添加上 前置公共函数 来初始化基础请求令牌。