草庐IT

Apifox手动和自动两种更新token方式(推荐自动)

风吹稻香 2023-06-17 原文

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. 创建一个 公共脚本 :

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

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

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

       

       这是我的脚本代码: 

       

      //定义学校端查看方案列表接口请求方法,看token是否失效
      function sendViewSchemeListRequest() {
          // 获取环境里的 前置URL
          const baseUrl = pm.environment.get("BASE_URL");
          const token = pm.environment.get("token");
          //从环境变量获取orgcode
          const orgcode = pm.environment.get("orgcode");
      
          // 构造一个 POST body 为 json 格式请求。
          const viewSchemeListRequest = {
              url: baseUrl + "/service/schooliscqe/scheme/schemeList",
              method: "POST",
              header: {
                  // 注意:header 需要加上 Content-Type
                  "Content-Type": "application/json",
                  'token': token,
                  'orgCode': orgcode,
              },
              body: {
                  mode: 'raw',// 此处为 raw
                  // 序列化后的 json 字符串
                  raw: JSON.stringify(
                      {
                          "data": { "current": 1, "pageSize": 10 }
                      }),
              },
          };
          // 发送请求。
          pm.sendRequest(viewSchemeListRequest, function (err, res) {
              if (err) {
                  console.log(err);
              } else {
                  const jsonData = res.json();
                  // 将 scheme_list_message写入环境变量
                  pm.environment.set("scheme_list_message", jsonData.message);
              }
          });
      }
      
      
      // 定义发送登录接口请求方法
      function sendLoginRequest() {
          // 获取环境里的 前置URL
          const baseUrl = pm.environment.get("BASE_URL_LOGIN");
          // 登录用户名,这里从环境变量 LOGIN_USERNAME 获取,也可以写死(但是不建议)
          const username = pm.environment.get("LOGIN_USERNAME");
          // 登录密码,这里从环境变量 LOGIN_PASSWORD 获取,也可以写死(但是不建议)
          const password = pm.environment.get("LOGIN_PASSWORD");
          //从环境变量获取orgcode
          const orgcode = pm.environment.get("orgcode");
      
          // 构造一个 POST body 为 json 格式请求。
          const loginRequest = {
              url: baseUrl + "/service/isptl/open/sso/login",
              method: "POST",
              header: {
                  // 注意:header 需要加上 Content-Type
                  "Content-Type": "application/json",
                  'appId': "JF-ISWCC-WEB",
                  'appToken': "9f3c8a5fc3710b08fc213b0955adac95eee853182b64496efe91e5d392e5e4a3614af5e43c1f945074e0ebe7ef895cae67a1368e61da8ca5c03dd98c94ee4c7c",
                  'timeStamp': "1680845431151",
                  'orgCode': orgcode,
              },
              body: {
                  mode: 'raw',// 此处为 raw
                  // 序列化后的 json 字符串
                  raw: JSON.stringify(
                      {
                          "data":
                          {
                              "loginType": "1",
                              "accountName": username,
                              "password": password,
                              "mobile": "",
                              "verifyCode": ""
                          }
                      }),
              },
          };
          // 发送请求。
          pm.sendRequest(loginRequest, function (err, res) {
              if (err) {
                  console.log(err);
              } else {
                  const jsonData = res.json();
                  // 将 token 写入环境变量 token
                  pm.environment.set("token", jsonData.data.token);
              }
          });
      }
      
      //请求学校端查看方案列表接口
      sendViewSchemeListRequest()
      // 获取环境变量里的 token
      const token = pm.environment.get("token");
      // 获取环境变量里的 message
      const message = pm.environment.get("message");
      
      // 如 token 没有值或者message信息不正确,则执行发送登录接口请求
      if (
          !token || message === "用户未登陆,请登录后重试" || message === "登录信息已过期,请重新登录"
      ) {
          sendLoginRequest();
      }

       

       

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

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

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

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

       

 

公共脚本示例

注意

  • 示例脚本里的登录用户名密码,是从环境变变量 LOGIN_USERNAME 和 LOGIN_PASSWORD 获取,如果你直接拷贝代码的话,记得要手动设置这两个环境变量。
  • 如果你们的 token 没有过期时间,可以将 token_expires相关的代码去除。
    // 定义发送登录接口请求方法
    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 + "/api/v1/login",
        method: "POST",
        // body 为 x-www-form-urlencoded 格式
        body: {
          mode: "urlencoded", // 此处为 urlencoded
          // 此处为 urlencoded
          urlencoded: [
            { key: "account", value: "apifox" },
            { key: "password", value: "123456" },
          ],
        },
        /*
        // 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://www.apifox.cn/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://www.apifox.cn/help/app/scripts/api-references/pm-reference/#pm-cookies
          const jsonData = res.json();
          // 将 accessToken 写入环境变量 ACCESS_TOKEN
          pm.environment.set("ACCESS_TOKEN", jsonData.data.accessToken);
          // 将 accessTokenExpires 过期时间写入环境变量 ACCESS_TOKEN_EXPIRES
          pm.environment.set(
            "ACCESS_TOKEN_EXPIRES",
            jsonData.data.accessTokenExpires
          );
        }
      });
    }
    
    // 获取环境变量里的 ACCESS_TOKEN
    const accessToken = pm.environment.get("ACCESS_TOKEN");
    
    // 获取环境变量里的 ACCESS_TOKEN_EXPIRES
    const accessTokenExpires = pm.environment.get("ACCESS_TOKEN_EXPIRES");
    
    // 如 ACCESS_TOKEN 没有值,或 ACCESS_TOKEN_EXPIRES 已过期,则执行发送登录接口请求
    if (
      !accessToken ||
      (accessTokenExpires && new Date(accessTokenExpires) <= new Date())
    ) {
      sendLoginRequest();
    }

有关Apifox手动和自动两种更新token方式(推荐自动)的更多相关文章

  1. ruby-on-rails - 使用 Ruby on Rails 进行自动化测试 - 最佳实践 - 2

    很好奇,就使用ruby​​onrails自动化单元测试而言,你们正在做什么?您是否创建了一个脚本来在cron中运行rake作业并将结果邮寄给您?git中的预提交Hook?只是手动调用?我完全理解测试,但想知道在错误发生之前捕获错误的最佳实践是什么。让我们理所当然地认为测试本身是完美无缺的,并且可以正常工作。下一步是什么以确保他们在正确的时间将可能有害的结果传达给您? 最佳答案 不确定您到底想听什么,但是有几个级别的自动代码库控制:在处理某项功能时,您可以使用类似autotest的内容获得关于哪些有效,哪些无效的即时反馈。要确保您的提

  2. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

    给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息? 最佳答案 在Rails3中,update_all不返回任何有意义的信息,除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

  3. ruby - 如何以所有可能的方式将字符串拆分为长度最多为 3 的连续子字符串? - 2

    我试图获取一个长度在1到10之间的字符串,并输出将字符串分解为大小为1、2或3的连续子字符串的所有可能方式。例如:输入:123456将整数分割成单个字符,然后继续查找组合。该代码将返回以下所有数组。[1,2,3,4,5,6][12,3,4,5,6][1,23,4,5,6][1,2,34,5,6][1,2,3,45,6][1,2,3,4,56][12,34,5,6][12,3,45,6][12,3,4,56][1,23,45,6][1,2,34,56][1,23,4,56][12,34,56][123,4,5,6][1,234,5,6][1,2,345,6][1,2,3,456][123

  4. ruby - 解析 RDFa、微数据等的最佳方式是什么,使用统一的模式/词汇(例如 schema.org)存储和显示信息 - 2

    我主要使用Ruby来执行此操作,但到目前为止我的攻击计划如下:使用gemsrdf、rdf-rdfa和rdf-microdata或mida来解析给定任何URI的数据。我认为最好映射到像schema.org这样的统一模式,例如使用这个yaml文件,它试图描述数据词汇表和opengraph到schema.org之间的转换:#SchemaXtoschema.orgconversion#data-vocabularyDV:name:namestreet-address:streetAddressregion:addressRegionlocality:addressLocalityphoto:i

  5. ruby-on-rails - 使用 rails 4 设计而不更新用户 - 2

    我将应用程序升级到Rails4,一切正常。我可以登录并转到我的编辑页面。也更新了观点。使用标准View时,用户会更新。但是当我添加例如字段:name时,它​​不会在表单中更新。使用devise3.1.1和gem'protected_attributes'我需要在设备或数据库上运行某种更新命令吗?我也搜索过这个地方,找到了许多不同的解决方案,但没有一个会更新我的用户字段。我没有添加任何自定义字段。 最佳答案 如果您想允许额外的参数,您可以在ApplicationController中使用beforefilter,因为Rails4将参数

  6. ruby - RuntimeError(自动加载常量 Apps 多线程时检测到循环依赖 - 2

    我收到这个错误:RuntimeError(自动加载常量Apps时检测到循环依赖当我使用多线程时。下面是我的代码。为什么会这样?我尝试多线程的原因是因为我正在编写一个HTML抓取应用程序。对Nokogiri::HTML(open())的调用是一个同步阻塞调用,需要1秒才能返回,我有100,000多个页面要访问,所以我试图运行多个线程来解决这个问题。有更好的方法吗?classToolsController0)app.website=array.join(',')putsapp.websiteelseapp.website="NONE"endapp.saveapps=Apps.order("

  7. ruby-on-rails - Rails 中的 NoMethodError::MailersController#preview undefined method `activation_token=' for nil:NilClass - 2

    似乎无法为此找到有效的答案。我正在阅读Rails教程的第10章第10.1.2节,但似乎无法使邮件程序预览正常工作。我发现处理错误的所有答案都与教程的不同部分相关,我假设我犯的错误正盯着我的脸。我已经完成并将教程中的代码复制/粘贴到相关文件中,但到目前为止,我还看不出我输入的内容与教程中的内容有什么区别。到目前为止,建议是在函数定义中添加或删除参数user,但这并没有解决问题。触发错误的url是http://localhost:3000/rails/mailers/user_mailer/account_activation.http://localhost:3000/rails/mai

  8. ruby-on-rails - 正确的 Rails 2.1 做事方式 - 2

    question的一些答案关于redirect_to让我想到了其他一些问题。基本上,我正在使用Rails2.1编写博客应用程序。我一直在尝试自己完成大部分工作(因为我对Rails有所了解),但在需要时会引用Internet上的教程和引用资料。我设法让一个简单的博客正常运行,然后我尝试添加评论。靠我自己,我设法让它进入了可以从script/console添加评论的阶段,但我无法让表单正常工作。我遵循的其中一个教程建议在帖子Controller中创建一个“评论”操作,以添加评论。我的问题是:这是“标准”方式吗?我的另一个问题的答案之一似乎暗示应该有一个CommentsController参

  9. jquery - 我的 jquery AJAX POST 请求无需发送 Authenticity Token (Rails) - 2

    rails中是否有任何规定允许站点的所有AJAXPOST请求在没有authenticity_token的情况下通过?我有一个调用Controller方法的JqueryPOSTajax调用,但我没有在其中放置任何真实性代码,但调用成功。我的ApplicationController确实有'request_forgery_protection'并且我已经改变了config.action_controller.consider_all_requests_local在我的environments/development.rb中为false我还搜索了我的代码以确保我没有重载ajaxSend来发送

  10. ruby-on-rails - Rails 中的推荐引擎 - 2

    我想为我的Rails网络应用程序提供推荐功能。特别是,我想向新注册的用户推荐他可能想要关注的其他用户。Rails中是否有用于此目的的引擎/gem?如果没有,我应该从哪里开始构建它?谢谢。 最佳答案 有Coletivogemhttps://github.com/diogenes/coletivo我试了一下。在MySQL上运行。Neo4jhttp://neo4j.org真的很容易实现一个“跟随谁”。事实上,大多数展示其能力的样本都涉及“跟随谁”。快速提示-只有在JRuby上运行时,Neo4j.rb才会很酷。如果不是-使用Neograph

随机推荐