• Apifox 关于token的使用方式


    前言,关于token的使用,仅做了简单的demo测试token效果。

    1.手动登录获取token
    顾名思义,因为只有登录之后才有token的信息,所以在调用其他接口前需要拥有token才能访问。

    操作步骤

    1)添加环境变量、全局参数

    这里拿测试环境举例,在右上角环境中配置详细信息:测试环境填写变量名以及本地值
    {{token}}

    再在全局参数添加参数名和默认值(这样就不用每个接口都写一遍token了)

    2)在登录接口运行中添加后置操作

    选择提取变量,将token填入,并且根据登录接口返回的数据结构获取对应的token。例如我这里就是$.data.token。

    添加完毕后,执行一次获取token接口,就会把登录接口返回的token数据填充到环境变量和全局参数中。

     这样请求其他接口就可以在实际参数中看到最新的token了

    特别注意:后置操作不是在接口文档中保存的,所以获取token的后置操作要保存为用例,下次运行用例才能将token填充到环境变量中去。

    2.全自动登录实现方式
    期望效果

    1、运行接口用例的时候,自动完成登录,而无需手动登录。

    2、自动登录过一次后,保存登录态,避免每次执行用例都调用登录接口。

    实现思路

    1、使用 环境变量(如:token)保存登录需要的凭证。

    2、如凭证有过期时间,使用环境变量(如:token_expires)保存登录凭证的过期时间。

    3、创建一个 公共脚本 :

    判断环境变量token是否有值,以及token_expires是否过期,如果存在且未过期,跳出执行,否则下一步。

    使用 pm.sendRequest 调用登录接口,将登录接口返回的登录凭证写入环境变量,过期时间也写入环境变量。

    我这里登录获取token接口是没有token_expires的,所以我去掉了相关代码,下面最后面有完整的官方示例代码,请参考!

    这是我的脚本代码:

    1. //定义学校端查看方案列表接口请求方法,看token是否失效
    2. function sendViewSchemeListRequest() {
    3. // 获取环境里的 前置URL
    4. const baseUrl = pm.environment.get("BASE_URL");
    5. const token = pm.environment.get("token");
    6. //从环境变量获取orgcode
    7. const orgcode = pm.environment.get("orgcode");
    8. // 构造一个 POST body 为 json 格式请求。
    9. const viewSchemeListRequest = {
    10. url: baseUrl + "/service/schooliscqe/scheme/schemeList",
    11. method: "POST",
    12. header: {
    13. // 注意:header 需要加上 Content-Type
    14. "Content-Type": "application/json",
    15. 'token': token,
    16. 'orgCode': orgcode,
    17. },
    18. body: {
    19. mode: 'raw',// 此处为 raw
    20. // 序列化后的 json 字符串
    21. raw: JSON.stringify(
    22. {
    23. "data": { "current": 1, "pageSize": 10 }
    24. }),
    25. },
    26. };
    27. // 发送请求。
    28. pm.sendRequest(viewSchemeListRequest, function (err, res) {
    29. if (err) {
    30. console.log(err);
    31. } else {
    32. const jsonData = res.json();
    33. // 将 scheme_list_message写入环境变量
    34. pm.environment.set("scheme_list_message", jsonData.message);
    35. }
    36. });
    37. }
    38. // 定义发送登录接口请求方法
    39. function sendLoginRequest() {
    40. // 获取环境里的 前置URL
    41. const baseUrl = pm.environment.get("BASE_URL_LOGIN");
    42. // 登录用户名,这里从环境变量 LOGIN_USERNAME 获取,也可以写死(但是不建议)
    43. const username = pm.environment.get("LOGIN_USERNAME");
    44. // 登录密码,这里从环境变量 LOGIN_PASSWORD 获取,也可以写死(但是不建议)
    45. const password = pm.environment.get("LOGIN_PASSWORD");
    46. //从环境变量获取orgcode
    47. const orgcode = pm.environment.get("orgcode");
    48. // 构造一个 POST body 为 json 格式请求。
    49. const loginRequest = {
    50. url: baseUrl + "/service/isptl/open/sso/login",
    51. method: "POST",
    52. header: {
    53. // 注意:header 需要加上 Content-Type
    54. "Content-Type": "application/json",
    55. 'appId': "JF-ISWCC-WEB",
    56. 'appToken': "9f3c8a5fc3710b08fc213b0955adac95eee853182b64496efe91e5d392e5e4a3614af5e43c1f945074e0ebe7ef895cae67a1368e61da8ca5c03dd98c94ee4c7c",
    57. 'timeStamp': "1680845431151",
    58. 'orgCode': orgcode,
    59. },
    60. body: {
    61. mode: 'raw',// 此处为 raw
    62. // 序列化后的 json 字符串
    63. raw: JSON.stringify(
    64. {
    65. "data":
    66. {
    67. "loginType": "1",
    68. "accountName": username,
    69. "password": password,
    70. "mobile": "",
    71. "verifyCode": ""
    72. }
    73. }),
    74. },
    75. };
    76. // 发送请求。
    77. pm.sendRequest(loginRequest, function (err, res) {
    78. if (err) {
    79. console.log(err);
    80. } else {
    81. const jsonData = res.json();
    82. // 将 token 写入环境变量 token
    83. pm.environment.set("token", jsonData.data.token);
    84. }
    85. });
    86. }
    87. //请求学校端查看方案列表接口
    88. sendViewSchemeListRequest()
    89. // 获取环境变量里的 token
    90. const token = pm.environment.get("token");
    91. // 获取环境变量里的 message
    92. const message = pm.environment.get("message");
    93. // 如 token 没有值或者message信息不正确,则执行发送登录接口请求
    94. if (
    95. !token || message === "用户未登陆,请登录后重试" || message === "登录信息已过期,请重新登录"
    96. ) {
    97. sendLoginRequest();
    98. }

    设置需要登录态的接口用例:

    将用来验证登录态的参数值设置为 {{token}} 。

    此处在环境里的全局参数统一设置,所有接口运行时会自动加上全局参数,无需每个接口手动设置。

    在 根目录前置操作里引用前面创建的公共脚本,保存后就可以了。

    公共脚本示例

    注意

    示例脚本里的登录用户名和密码,是从环境变变量 LOGIN_USERNAME 和 LOGIN_PASSWORD 获取,如果你直接拷贝代码的话,记得要手动设置这两个环境变量。

    如果你们的 token 没有过期时间,可以将 token_expires相关的代码去除。

    1. // 定义发送登录接口请求方法
    2. function sendLoginRequest() {
    3. // 获取环境里的 前置URL
    4. const baseUrl = pm.environment.get("BASE_URL");
    5. // 登录用户名,这里从环境变量 LOGIN_USERNAME 获取,也可以写死(但是不建议)
    6. const username = pm.environment.get("LOGIN_USERNAME");
    7. // 登录密码,这里从环境变量 LOGIN_PASSWORD 获取,也可以写死(但是不建议)
    8. const password = pm.environment.get("LOGIN_PASSWORD");
    9. // 构造一个 POST x-www-form-urlencoded 格式请求。这里需要改成你们实际登录接口的请求参数。
    10. const loginRequest = {
    11. url: baseUrl + "/api/v1/login",
    12. method: "POST",
    13. // body 为 x-www-form-urlencoded 格式
    14. body: {
    15. mode: "urlencoded", // 此处为 urlencoded
    16. // 此处为 urlencoded
    17. urlencoded: [
    18. { key: "account", value: "apifox" },
    19. { key: "password", value: "123456" },
    20. ],
    21. },
    22. /*
    23. // body 为 form-data 格式
    24. body: {
    25. mode: 'formdata', // 此处为 formdata
    26. // 此处为 formdata
    27. formdata: [
    28. { key: 'account', value: 'apifox' },
    29. { key: 'password', value: '123456' }
    30. ]
    31. }
    32. // body 为 json 格式
    33. header: {
    34. "Content-Type": "application/json", // 注意:header 需要加上 Content-Type
    35. },
    36. body: {
    37. mode: 'raw',// 此处为 raw
    38. raw: JSON.stringify({ account: 'apifox', password:'123456' }), // 序列化后的 json 字符串
    39. }
    40. // body 为 raw 或 json 格式
    41. body: {
    42. mode: 'raw',
    43. raw: '此处为 body 内容',
    44. }
    45. */
    46. };
    47. // 发送请求。
    48. // pm.sendrequest 参考文档: https://www.apifox.cn/help/app/scripts/api-references/pm-reference/#pm-sendrequest
    49. pm.sendRequest(loginRequest, function(err, res) {
    50. if (err) {
    51. console.log(err);
    52. } else {
    53. // 读取接口返回的 json 数据。
    54. // 如果你的 token 信息是存放在 cookie 的,可以使用 res.cookies.get('token') 方式获取。
    55. // cookies 参考文档:https://www.apifox.cn/help/app/scripts/api-references/pm-reference/#pm-cookies
    56. const jsonData = res.json();
    57. // 将 accessToken 写入环境变量 ACCESS_TOKEN
    58. pm.environment.set("ACCESS_TOKEN", jsonData.data.accessToken);
    59. // 将 accessTokenExpires 过期时间写入环境变量 ACCESS_TOKEN_EXPIRES
    60. pm.environment.set(
    61. "ACCESS_TOKEN_EXPIRES",
    62. jsonData.data.accessTokenExpires
    63. );
    64. }
    65. });
    66. }
    67. // 获取环境变量里的 ACCESS_TOKEN
    68. const accessToken = pm.environment.get("ACCESS_TOKEN");
    69. // 获取环境变量里的 ACCESS_TOKEN_EXPIRES
    70. const accessTokenExpires = pm.environment.get("ACCESS_TOKEN_EXPIRES");
    71. //ACCESS_TOKEN 没有值,或 ACCESS_TOKEN_EXPIRES 已过期,则执行发送登录接口请求
    72. if (
    73. !accessToken ||
    74. (accessTokenExpires && new Date(accessTokenExpires) <= new Date())
    75. ) {
    76. sendLoginRequest();
    77. }

    最后感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走:

    文档获取方式:

    这份文档,对于想从事【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴我走过了最艰难的路程,希望也能帮助到你!

    以上均可以分享,只需要你搜索vx公众号:程序员雨果,即可免费领取

  • 相关阅读:
    Django的简单介绍
    顾客餐馆点菜
    管理那些事
    越细粒度的锁越好吗?产生死锁怎么办?
    数据通信网络基础
    webp格式如何转成png?
    Kubernetes入门到精通- Operator 模式入门
    盘点 4 个开源小游戏
    mac 安装部署mongoDB社区版
    【代码阅读】PL-VIO
  • 原文地址:https://blog.csdn.net/2301_77645834/article/details/133278956