Apifox前置操作获取token

35s

已于 2024-11-07 18:16:32 修改

阅读量1k

点赞数 6

文章标签： apifox postman

于 2024-11-07 15:48:56 首次发布

本文链接：https://blog.youkuaiyun.com/qq_40429067/article/details/143595970

版权

1. 前情提要

最近突然发现最新版的apifox已经支持各种环境变量的切换了，达到了我的使用习惯，所以便立马从postman切到了apifox，毕竟还是中文页面看着舒服，也可以探索各种操作

之前我每次尝试通过postman模拟线上页面请求时，都需要登录对应账号，从控制台抓取token，感觉很麻烦，使用了apifox后，看到了前置操作/后置操作，感觉出现了可玩性

2. 在探索过程中，发现两种玩法可以拯救我上述的复杂操作

2.1 获取token接口和业务接口独立

2.1.1 这种操作需要额外先请求一次获取token的接口，提取接口返回值中的token设置为环境变量，当再次请求业务接口时，业务接口配置读取对应变量就可以了（注意提取的变量名要和使用的对应上哦）

在这里插入图片描述

2.2 获取token接口作为业务接口的前置脚本

2.2.1 我也基于上述操作探索过能不能让获取token接口作为业务接口的前置操作接口，但是好像整不了（有人会的话可以教教我，这样可以省了很多事情）

2.2.2 这种方式需要在业务接口新增一个前置脚本，代码是我在官网复制下来的，基于我的token接口返回的格式修改了一点点

注意环境变量BASE_URL、LOGIN_USERNAME、LOGIN_PASSWORD，这些需要手动设置环境变量，当然也可以在脚本里写死
注意loginRequest对象里url的拼接

// 定义发送登录接口请求方法
function sendLoginRequest() {
  // 获取环境里的 前置 URL
  const baseUrl = pm.environment.get("BASE_URL");

  // 登录用户名，这里从环境变量 LOGIN_USERNAME 获取，也可以写死（但是不建议）
  const username = pm.environment.get("LOGIN_USERNAME");

  // 登录密码，这里从环境变量 LOGIN_PASSWORD 获取，也可以写死（但是不建议）
  const password = pm.environment.get("LOGIN_PASSWORD");

  // 构造一个 POST x-www-form-urlencoded 格式请求。这里需要改成你们实际登录接口的请求参数。
  const loginRequest = {
    url: baseUrl + "/oauth/oauth/token",
    method: "POST",
    // body 为 x-www-form-urlencoded 格式
    body: {
      mode: "urlencoded", // 此处为 urlencoded
      // 此处为 urlencoded
      urlencoded: [
        { key: "grant_type", value: "password" },
        { key: "client_id", value: "client" },
        { key: "client_secret", value: "secret" },
        { key: "username", value: username },
        { key: "password", value: password },
      ],
    },
    /*
    // body 为 form-data 格式
    body: {
      mode: 'formdata', // 此处为 formdata
      // 此处为 formdata
      formdata: [
        { key: 'account', value: 'apifox' },
        { key: 'password', value: '123456' }
      ]
    }

    // body 为 json 格式
    header: {
      "Content-Type": "application/json", // 注意：header 需要加上 Content-Type
    },
    body: {
      mode: 'raw',// 此处为 raw
      raw: JSON.stringify({ account: 'apifox', password:'123456' }), // 序列化后的 json 字符串
    }

    // body 为 raw 或 json 格式
    body: {
      mode: 'raw',
      raw: '此处为 body 内容',
    }
    */
  };

  // 发送请求。
  // pm.sendrequest 参考文档: https://apifox.com/help/app/scripts/api-references/pm-reference/#pm-sendrequest
  pm.sendRequest(loginRequest, function(err, res) {
    if (err) {
      console.log(err);
    } else {
      // 读取接口返回的 json 数据。
      // 如果你的 token 信息是存放在 cookie 的，可以使用 res.cookies.get('token') 方式获取。
      // cookies 参考文档：https://apifox.com/help/app/scripts/api-references/pm-reference/#pm-cookies
      const jsonData = res.json();
      console.log("data = "+JSON.stringify(jsonData))
      // 将 accessToken 写入环境变量 ACCESS_TOKEN
      console.log("token = " + jsonData.access_token)
      pm.environment.set("ADMIN_TOKEN", jsonData.access_token);
      // 将 accessTokenExpires 过期时间写入环境变量 ACCESS_TOKEN_EXPIRES
      pm.environment.set(
        "ACCESS_TOKEN_EXPIRES",
        jsonData.expires_in
      );
    }
  });
}

// 获取环境变量里的 ACCESS_TOKEN
const accessToken = pm.environment.get("ADMIN_TOKEN");
console.log("token = "+accessToken)
// 获取环境变量里的 ACCESS_TOKEN_EXPIRES
const accessTokenExpires = pm.environment.get("ACCESS_TOKEN_EXPIRES");

// 如 ACCESS_TOKEN 没有值，或 ACCESS_TOKEN_EXPIRES 已过期，则执行发送登录接口请求
if (
  !accessToken ||
  (accessTokenExpires && new Date(accessTokenExpires) <= new Date())
) {
  console.log("start get token")
  sendLoginRequest();
}

在这里插入图片描述

2.2.3 V2版本

上面的脚本存在一些错误，比如pm.environment.get("ADMIN_TOKEN")、pm.environment.get("ACCESS_TOKEN_EXPIRES")，常量不应该用引号包裹，还有获取token接口返回的过期时间是剩余的毫秒数而不是未来过期的时间戳，所以直接判断的话每次都是重新获取token
我尝试1 :将每个服务的url拼接到环境变量token的key中，这样可以缓存多个key（我把服务url当成实际环境url来使用的，比如STG_http://www.hello.stg.com、DEV_http://www.hello.dev.com），但是这样的话在Auth设置token时，怎么把服务url拼上token key（STG/DEV）都不行，遂放弃
我尝试2 :由于获取token接口返回的过期时间是剩余可用的毫秒，所以不方便比较，想在第一次获取token时，设置一个当前时间，下一次获取的时候使用当前时间剪掉拿到上次缓存token的时间，如果大于一天（自定义）就重新获取token，以减轻服务器压力，但是身为一个后端我不知道咋整，好多时间的函数都需要额外引入前端库，这个应该不行，遂放弃
最终，成就了V2版本，省掉那么多花里胡哨的，服务器这点压力都承受不了，玩什么玩（摔桌）

// 定义发送登录接口请求方法
function sendLoginRequest() {
  // 获取环境里的 前置 URL
  const baseUrl = pm.request.getBaseUrl();

  // 登录用户名，这里从环境变量 LOGIN_USERNAME 获取，也可以写死（但是不建议）
  const username = pm.environment.get("LOGIN_USERNAME");

  // 登录密码，这里从环境变量 LOGIN_PASSWORD 获取，也可以写死（但是不建议）
  const password = pm.environment.get("LOGIN_PASSWORD");

  // 构造一个 POST x-www-form-urlencoded 格式请求。这里需要改成你们实际登录接口的请求参数。
  const loginRequest = {
    url: baseUrl + "/oauth/oauth/token",
    method: "POST",
    // body 为 x-www-form-urlencoded 格式
    body: {
      mode: "urlencoded", // 此处为 urlencoded
      // 此处为 urlencoded
      urlencoded: [
        { key: "grant_type", value: "password" },
        { key: "client_id", value: "client" },
        { key: "client_secret", value: "secret" },
        { key: "username", value: username },
        { key: "password", value: password },
      ],
    },
    /*
    // body 为 form-data 格式
    body: {
      mode: 'formdata', // 此处为 formdata
      // 此处为 formdata
      formdata: [
        { key: 'account', value: 'apifox' },
        { key: 'password', value: '123456' }
      ]
    }

    // body 为 json 格式
    header: {
      "Content-Type": "application/json", // 注意：header 需要加上 Content-Type
    },
    body: {
      mode: 'raw',// 此处为 raw
      raw: JSON.stringify({ account: 'apifox', password:'123456' }), // 序列化后的 json 字符串
    }

    // body 为 raw 或 json 格式
    body: {
      mode: 'raw',
      raw: '此处为 body 内容',
    }
    */
  };

  // 发送请求。
  // pm.sendrequest 参考文档: https://apifox.com/help/app/scripts/api-references/pm-reference/#pm-sendrequest
  pm.sendRequest(loginRequest, function (err, res) {
    if (err) {
      console.log(err);
    } else {
      // 读取接口返回的 json 数据。
      // 如果你的 token 信息是存放在 cookie 的，可以使用 res.cookies.get('token') 方式获取。
      // cookies 参考文档：https://apifox.com/help/app/scripts/api-references/pm-reference/#pm-cookies
      const jsonData = res.json();
      console.log("data = " + JSON.stringify(jsonData))
      // 将 accessToken 写入环境变量 ACCESS_TOKEN
      console.log("token = " + jsonData.access_token)
      pm.environment.set(ADMIN_TOKEN_KEY, jsonData.access_token);
    }
  });
}

// 获取环境变量里的 ACCESS_TOKEN
const ADMIN_TOKEN_KEY = "ADMIN_TOKEN"
const accessToken = pm.environment.get(ADMIN_TOKEN_KEY);
console.log("token = " + accessToken)
console.log("start get token")
sendLoginRequest();