接口测试之-postman

Posted zhouyun-test

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了接口测试之-postman相关的知识,希望对你有一定的参考价值。

在使用postman进行接口测试的时候,对于有些接口字段需要时间戳加密,这个时候我们就遇到2个问题,其一是接口中的时间戳如何得到?其二就是对于现在常用的md5加密操作如何在postman中使用代码实现呢?
  下面我们以一个具体的接口例子来进行说明。
  首先来看看我们的接口文档信息,如图所示
技术分享图片
  此接口文档中,需要三个参数customercode、timestamp和itoken(是customerCode+timestamp+ytoken加密后的结果)。
  第一次操作的时候,我们使用postman会这样操作,如图
 技术分享图片
  这样操作流程是:
  1、选择提交方式是post,输入接口的url地址
  2、选择接口情况的方式是x-www-form-urlencoded
  3、设置接口的参数customerCode、timestamp和itoken和值
  4、设置完成之后点击send发送,查看接口响应结果
  说明
  x-www-form-urlencoded即是application/x-www-from-urlencoded,将表单内的数字转换为键对值
  postman中 form-data、x-www-form-urlencoded、raw、binary的区别:
  http://blog.csdn.net/ye1992/article/details/49998511
  时间戳转换工具:
  http://tool.chinaz.com/Tools/unixtime.aspx
  md5加密工具:
  https://md5jiami.51240.com/
  这样创建会话的接口我们就完成了!但是为了系统的安全性,这里的timestamp是每30分钟就会过期的,下次我们又需要重新设置timestamp,就是md5加密的结果......这样操作岂不是太麻烦?
  还好postman中Pre-Request Script可以在 Request 之前自定义请求数据,这样做的好处就是可以以嵌入脚本的方式动态准备测试数据,并根据业务需求设计测试用例
  这里我们仍继续以上面的用例为例:
  在postman中,如何才能获取当前机器上的timestamp呢?
  Math.round(new Date().getTime())
  可以满足我们的要求!!!
  那代码如何实现呢?
  //设置当前时间戳毫秒
  postman.setGlobalVariable("timestamp",Math.round(new Date().getTime()));
  这样就将获取的时间戳设置为全局变量timestamp
  我们知道itoken的值是md5(customerCode+timestamp+ytoken‘)
  那么接下来就可以动态的获取md5的信息了,代码如下:
//发起请求之前获取当前的时间戳放在参数里
//postman.setGlobalVariable("customerCode","***2345677***");
//1.设置环境变量 postman.setEnvironmentVariable("key", "value");
//2.设置全局变量 postman.setGlobalVariable("key", "value");
//environment.customerCode = "***2345677***";
customerCode = postman.getGlobalVariable("customerCode");
//设置当前时间戳毫秒
postman.setGlobalVariable("timestamp",Math.round(new Date().getTime()));
//environment.timestamp = Math.round(new Date().getTime());
//postman.setEnvironmentVariable("unixtime_now","timecode");
//var jsonData = JSON.parse(request.data.applyJsonStr);
//postman.setGlobalVariable("ytoken","*********b176a4739bfccb*********");
//获取全局变量
//如postman.getGlobalVariable("key");
customerCode = postman.getGlobalVariable("customerCode");
timestamp = postman.getGlobalVariable(‘timestamp‘);
ytoken = postman.getGlobalVariable("ytoken");
var str = customerCode+timestamp+ytoken;
//postman.setEnvironmentVariable("str",str);
//environment.str = str;
postman.setGlobalVariable("str",str);
//var md5 = CryptoJS.MD5(str).toString().toLowerCase();
//使用md5加密
//var strmd5 = CryptoJS.MD5(str).toString();
var strmd5 = CryptoJS.MD5(str);
//environment.strmd5 = strmd5;
postman.setGlobalVariable(‘md5‘,strmd5);
//environment.md5 = md5;
//timecode=System.currentTimeMillis();
console.log(str);
  而在接口请求中,就可以使用已经定义好的变量来进行接口操作,代码如下
customerCode:{{customerCode}}
timestamp:{{timestamp}}
ltoken:{{md5}}
  如图所示
技术分享图片
  这样下次创建接口的时候,直接运行该用例即可,不用再次修改参数值~(≧▽≦)/~
  那么我们如何才能知道该接口用例是成功的呢,该怎么断言呢?
  这里列出我该接口断言的一个示例,代码如下
/*
// 推荐用全等 ===,确保类型和值都一致
tests[‘Status code is 200‘] = responseCode.code === 200;
// 判断是否存在 ‘success‘ 值
tests["Body matches code"] = responseBody.has("0");
var jsonData = JSON.parse(responseBody);
postman.setEnvironmentVariable("sessionId",jsonData.result);
tests[`[INFO] Request params: ${JSON.stringify(request.data)}`] = true;
tests["have result "]=jsonData.hasOwnProperty("error")!==true;
tests[`[INFO] Response timeout: ${responseTime}`] = responseTime < 6000;
**/
//状态代码是200
if(responseCode.code === 200){
// 判断是否存在 ‘success‘ 值,检查响应体包含一个字符串
tests["Body matches code"] = responseBody.has("0");
//响应结果中result保存为全局变量sessonId
var jsonData = JSON.parse(responseBody);
postman.setGlobalVariable("sessionId",jsonData.result);
//输入接口参数信息
tests[`[INFO] Request params: ${JSON.stringify(request.data)}`] = true;
// tests["have result "]=jsonData.hasOwnProperty("error")!==true;
//判断接口响应结果有result
tests["have result "]=jsonData.hasOwnProperty("result")===true;
//判断接口响应时间小于N秒
tests[`[INFO] Response timeout: ${responseTime}`] = responseTime < 6000;
}else{
//接口请求失败
tests["Waring:Request Failed. Please Fix!"] = false;
}
  这样创建会话的接口就完成了!
 
 
 
 
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
 
 

简介

  Postman 使一款可以方便我们调用API的工具,通过Postman 与 Newman结合我们还可以批量运行API达到API自动化测试的目的。

 

Postman 安装

  Window 系统需要先安装Chrome浏览器,然后在应用商店找到Postman插件,直接点击安装便可:https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=cn

技术分享图片

测试GET类型API以豆瓣搜索图书API为例

技术分享图片

这个接口的method为get,postman默认为get,在url栏输入被测接口

技术分享图片

get请求


在接口文档中,q与tag其中的一个是必填项,所以这里需要配置参数,点击url右侧的params,并输入参数

技术分享图片

点击send按钮发送请求,在下面可以看到返回的response,响应的状态码,与响应时间

技术分享图片

response还可以以不同的方式查看,并且还可以看到cookies,headers信息

技术分享图片

每次以不同的参数或者设置,在左侧history都会帮我们记录一个接口测试历史,以便于下次重新调用

技术分享图片

测试POST类型API

以Postman自带的接口为例
选取请求的方法为POST,并输入接口地址,因为post请求大多是json形式,所以可以打开Body选项,并选择JSON(application/json)形式,输入请求的json,同样其余的操作跟GET接口一样。

技术分享图片

post

变量的设置

编写的API往往需要在多个环境下执行,而Postman 提供了两种类型的变量:环境变量和全局变量,从而很好的解决了这个问题。
环境变量有效范围仅仅在于你所选取的环境,全局变量对所有的环境都试用。

环境变量

api可能需要在拨通的环境中运行,所以api请求的服务器地址不能写死,希望是可以配置的,创建环境变量有多种方式。

  1. 手工预先创建环境变量

技术分享图片

  1. 代码自动创建环境变量
    自动新建环境变量可在两种情况下创建,但是创建方式相同都是用了postman提供的方法:
    postman.setEnvironmentVariable("key", "value");

    1. 在某个请求发起之前创建:
      在Pre-request Script标签里面添加代码:

      技术分享图片

    2. 在某个请求发起之后创建:
      在Tests标签里面添加如下

      技术分享图片

全局变量

全部变量跟环境变量的创建类似,也可以通过手工预先创建或者通过代码去创建。

  1. 通过手工预先创建

技术分享图片

  1. 通过代码创建
    2.1 在请求发起前创建
    在Pre-request Script标签里面添加代码:

    postman.setGlobalVariable("key", "value");

    2.2 在请求发起后创建
    在Tests标签里面添加如下:

    postman.setGlobalVariable("key", "value");

    变量的引用

    在需要的地方加上{{变量名}}便可

随机数

PostMan 除了提供环境变量和全局变量外,还提供了三种随机数。
{{$guid}}
:添加一个V4风格GUID

{{$timestamp}}
:将当前的时间戳,精确到秒

{{$randomInt}}
:添加0和1000之间的随机整数

测试

  Postman可以在tests里面,用自带的脚本对接口进行测试,单击tests标签后可以看到右侧有个snippets栏,里面就是postman内置的测试脚本,辅助对接口进行测试。

技术分享图片

  选择其中的一个脚本,修改其中的参数,再次点击send,这时response的tests出现了一个1/1,说明执行一个测试并且通过测试,绿色pass说明验证通过

技术分享图片

  红色fail说明测试不通过,一个接口可以写多个脚本进行多次测试

技术分享图片


  内置脚本说明:

1. 清除一个全局变量
     Clear a global variable
    对应脚本:
    postman.clearGlobalVariable("variable_key");
    参数:需要清除的变量的key2.清除一个环境变量
    Clear an environment variable
    对应脚本:
    postman.clearEnvironmentVariable("variable_key");
    参数:需要清除的环境变量的key3.response包含内容
    Response body:Contains string
    对应脚本:
    tests["Body matches string"] =responseBody.has("string_you_want_to_search");
    参数:预期内容4.将xml格式的response转换成son格式
    Response body:Convert XML body to a JSON Object
    对应脚本:    var jsonObject = xml2Json(responseBody);
    参数:(默认不需要设置参数,为接口的response)需要转换的xml5.response等于预期内容
    Response body:Is equal to a string
    对应脚本:
    tests["Body is correct"] = responseBody === "response_body_string";
    参数:预期response6.json解析key的值进行校验
    Response body:JSON value check
    对应脚本:
    tests["Args key contains argument passed as url parameter"] = ‘test‘ in responseJSON.args
    参数:test替换被测的值,args替换被测的key7.检查response的header信息是否有被测字段
    Response headers:Content-Type header check
    对应脚本:
    tests["Content-Type is present"] = postman.getResponseHeader("Content-Type");
    参数:预期header8.响应时间判断
    Response time is less than 200ms
    对应脚本:
    tests["Response time is less than 200ms"] = responseTime < 200;
    参数:响应时间9.设置全局变量      Set an global variable
      对应脚本:
      postman.setGlobalVariable("variable_key", "variable_value");
      参数:全局变量的键值10.设置环境变量      Set an environment variable
      对应脚本:
      postman.setEnvironmentVariable("variable_key", "variable_value");
      参数:环境变量的键值11.判断状态码
      Status code:Code is 200
      对应脚本:
      tests["Status code is 200"] = responseCode.code != 400;
      参数:状态码12.检查code name 是否包含内容
      Status code:Code name has string
      对应脚本:
      tests["Status code name has string"] = responseCode.name.has("Created");
      参数:预期code name包含字符串13.成功的post请求
      Status code:Successful POST request
      对应脚本:
      tests["Successful POST request"] = responseCode.code === 201 || responseCode.code === 202;14.微小验证器
       Use Tiny Validator for JSON data            
       对应脚本: 
        var schema = {         "items": {         "type": "boolean"
             }
         };        var data1 = [true, false];        var data2 = [true, 123];        console.log(tv4.error);
        tests["Valid Data1"] = tv4.validate(data1, schema);
        tests["Valid Data2"] = tv4.validate(data2, schema);
        参数:可以修改items里面的键值对来对应验证json的参数

使用Runner功能和外部数据

  Postman 工具自带了Runner功能,用于批量运行脚本。在运行时还可以使用外部的CSV或者json文件来指定数据。
  例如现在新建了如下两个外部数据,第一个保存为.json文件,第二个保存为.csv文件。

技术分享图片

技术分享图片


  新建如下GET请求API,并放于单独一个文件夹中管理。接口请求中{{host}}便是用来获取上步新建的两个文件夹中的数据,{{}}中的名字对应json文件的key值,对应csv文件中的第一行值。

技术分享图片


  点击Runner按钮,打开Runner界面:

技术分享图片


  在新打开的窗口中,选着你要刚新建的文件夹名,选择你要运行的环境,运行的次数和在Data File中选择刚新建的外部json或者csv文件,并选取文件类型,点击Start Test,变开始逐条读取外部文件中的数据,进行运行。

技术分享图片

Postman Interceptor

Interceptor 可以直接从浏览器中获取请求,并保存在Postman的History中。 这个插件可以大大缩短API配置的时间,同样Interceptor还有一个功能可以让Postman和Chrome浏览器共用Chrome的Cookies。

安装 Interceptor

  Interceptor 同样是Chrome的一个插件,所以也可以从Chrome网上商店找到该插件: https://chrome.google.com/webstore/detail/postman-interceptor/aicmkgpgakddgnaphhhpliifpcfhicfo/support?hl=cn ,直接点击安装。安装完后会在Chrome 插件中找到下图标识。

技术分享图片

使用 Interceptor

  开启Interceptor插件,并设置你要抓取的网站请求

技术分享图片

  在Postman 上同样打开Interceptor

技术分享图片

  这时在Chrome浏览器上访问一些baidu相关域名就会自动被Postman抓取,并在Postman的History显示

技术分享图片

Newman

官方帮助文档地址:https://www.npmjs.com/package/newman

Newman 安装

  嗯,它需要安装,因为它不是音乐播放器!Newman是为Postman而生,专门用来运行Postman编写好的脚本。Newman安装步骤:

  1. 需要安装nodejs,并配置好环境

  2. 打开控制台,运行:npm install -g newman

技术分享图片

Paste_Image.png

  1. 校验是否安装成功,运行:newman --version

技术分享图片

Newman 执行脚本

  Newman在3版本后做了比较大的改动,但是运行命令越来越简单如下:

newman run <collection-file-source> [options]

run 后面跟上要执行的json文件或者URL(json 和 URL 都由postman导出生成),再后面跟一些参数,例如环境变量,测试报告,接口请求超时时间等等。最后给两个完整的例子做参考:
例子1,通过newman 运行postman导出的test1.json文件,并生成多种测试报告(json,junit的xml,html):

newman run c:	est1.json --reporters cli,html,json,junit --reporter-json-export jsonOut.json --reporter-junit-export xmlOut.xml --reporter-html-export htmlOut.html

例子2,运行https://www.getpostman.com/collections/cb0cea0af1467c8008fb(postman生成的 )中的所有api,并使用env.json作为环境变量和globals.json作为全局变量,并使用外部data.csv作为外部数据,最后设置了接口请求超时时间为5S 。

newman run https://www.getpostman.com/collections/cb0cea0af1467c8008fb --environment env.json --iteration-data data.csv --globals globals.json --timeout-request 5000

Jenkins 结合

  平时做接口自动化,避免不了最后通过Jenkins做构建。既然Newman提供了控制台命令执行方式,那么像通过Jenkins来构建也就容易多了。
步骤一:在Jenkins 机器上安装Newman
步骤二:搭建Jenkins环境,并新建个自由风格的Job
步骤三:构建选择Execute Windows batch command,并输入newman 运行命令

技术分享图片

步骤四:因为上面命令中构建会生成junit的xml报告,所以可以在构建后用Publish JUnit test result report 插件来生成测试报告。

技术分享图片

 
























以上是关于接口测试之-postman的主要内容,如果未能解决你的问题,请参考以下文章

接口测试之Postman使用全指南(原来使用 Postman测试API接口如此简单)

软件测试之如何用Postman做接口自动化测试,新手必看

接口测试实战接口自动化之持续集成(postman+newman+jenkins)

接口测试实战postman之Collections和数据驱动测试实战

postman添加断言

postman之接口测试技巧