欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

postman接口测试七

程序员文章站 2024-03-21 23:10:10
...

目录

Postman 常用测试结果验证及使用技巧


Postman 常用测试结果验证及使用技巧

Postman的test本质上是JavaScript代码,通过我们编写测试代码,每一个tests返回True,或是False。
每一个tests实际上就是一个测试用例

官方文档给出了很多验证方式,我们通过实例来进行学习

接口返回结果为json

{
  "status": 301,
  "message": "购买商品库存不足",
  "lists": [11]
}
  • 1

  • 2

  • 3

  • 4

  • 5

1.检查response的body中是否包含字符串

tests["测试点"] = responseBody.has("需要查找的字符串");
  • 1

例:

tests["status code"] = responseBody.has("301");
tests["status是否存在"] = responseBody.has("status");
tests["lists是否存在"] = responseBody.has("lists");
tests["lists值为11"] = responseBody.has("11");
  • 1

  • 2

  • 3

  • 4

注:当json中value为integer时,需要查找的值可以不带双引号,
tests[“xxx”]xxx代表的是你测试点的名字,可以是中文
tests[“xxx”]xxx在一个脚本中如果出现多次,那么只执行第一个,所以尽量不要重复
当value等于中文字符串时,这个方法貌似就不怎么好用了,但是我们有别的方法去验证,往下看

2.检查Response Body是否等于字符串

tests["测试点"] = responseBody === "Response Body返回的内容";
  • 1

这个可以用在接口返回内容为纯字符串时,直接检查整个返回结果的正确性,
例子:
接口返回:哈哈

tests["返回为哈哈"] = responseBody === "哈哈";
tests["返回为哈哈"] = responseBody === "哈";
  • 1

  • 2

第二个会返回False,必须完全匹配

3.检查相应时间

tests["Response time 小于200毫秒"] = responseTime < 200;
tests["Response time 大于200毫秒"] = responseTime > 200;
  • 1

  • 2

4.检查状态码

这个也好理解,就是http请求状态码

tests["Status code is 200"] = responseCode.code === 200;
  • 1

注:
这里的状态码,跟上面我们用的json里边的"status"不是一回事

5.Code name contains a string

tests["Status code name has string"] = responseCode.name.has("Created");
tests["502"] = responseCode.name.has("Server");
tests["502"] = responseCode.name.has("Unreachable Server");
  • 1

  • 2

  • 3

这个我的理解是,检查HTTP code 对应的string,如下面给出的list
如下对应表,如果使用fiddler模拟相应的返回,注意fiddler返回的大小写有问题,用下表的string
1 消息(1字头)
▪ 100 Continue
2 成功(2字头)
▪ 200 OK
3 重定向(3字头)
▪ 300 Multiple Choices
▪ 301 Moved Permanently
▪ 302 Move temporarily
。。。。。
▪ 500 Internal Server Error
▪ 501 Not Implemented
▪ 502 Bad Gateway
▪ 503 Service Unavailable
▪ 600 Unparseable Response Headers(省略了一些)

6.设置环境变量/全局变量

pm.environmentVariable.set("key", "value");
pm.globalVariable.set("key", "value");
  • 1

  • 2

7.把XML的body转换成JSON对象:

var jsonObject = xml2Json(responseBody);
  • 1

8.检查json的值

var jsonData = JSON.parse(responseBody);tests["Your test name"] = jsonData.value === 100;
还拿上面的json数据做测试
tests["状态码为301"] = jsonData["status"] == "301";
tests["message"] = jsonData["message"] == "购买商品库存不足";
tests["list"] = jsonData["lists"][0] == "11";
  • 1

  • 2

  • 3

  • 4

  • 5

9.检查有信息

tests["Content-Type is present"] = postman.getResponseHeader("content-Type");//不区分大小写
tests["Content-Type is present"] = responseHeaders.hasOwnProperty("Content-Type");//区分大小写
  • 1

  • 2

10.POST request状态码

tests["Successful POST request"] = responseCode.code === 201 || responseCode.code === 202;
201 - Created 服务器已经创建了文档,Location头给出了它的URL。
202 - Accepted 已经接受请求,但处理尚未完成。
  • 1

  • 2

  • 3

官方文档中还给出了对于json的验证例子
这种基于JSON格式定义JSON数据结构的规范,我们叫他

官方例子

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);
  • 1

data1和data2是测试数据,schema相当于验证json的规范
示例中验证data1和data2中的value是否都是boolean类型

先了解下书写json规范文档常用的关键字

关键字 描述
$schema $schema 关键字状态,表示这个模式与 v4 规范草案书写一致。
title 用它给我们的模式提供了标题。
description 关于模式的描述。
type type 关键字在我们的 JSON 数据上定义了第一个约束:必须是一个 JSON 对象。
properties 定义各种键和他们的值类型,以及用于 JSON 文件中的最小值和最大值。
required 存放必要属性列表。
minimum 给值设置的约束条件,表示可以接受的最小值。
exclusiveMinimum 如果存在 “exclusiveMinimum” 并且具有布尔值 true,如果它严格意义上大于 “minimum” 的值则实例有效。
maximum 给值设置的约束条件,表示可以接受的最大值。
exclusiveMaximum 如果存在 “exclusiveMinimum” 并且具有布尔值 true,如果它严格意义上小于 “maximum” 的值则实例有效。
multipleOf 如果通过这个关键字的值分割实例的结果是一个数字则表示紧靠 “multipleOf” 的数字实例是有效的。
maxLength 字符串实例字符的最大长度数值。
minLength 字符串实例字符的最小长度数值。
pattern 如果正则表达式匹配实例成功则字符串实例被认为是有效的。

还拿第一个json做例子

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "id": "",
    "properties": {
        "lists": {
            "id": "",
            "items": {
                "default": 11,
                "description": "检查list值",
                "id": "",
                "title": "",
                "type": "integer"
            },
            "type": "array"
        },
        "message": {
            "default": "购买商品库存不足",
            "description": "message信息",
            "id": "",
            "title": "",
            "type": "string"
        },
        "status": {
            "default": 301,
            "description": "返回状态值",
            "id": "",
            "title": "",
            "type": "integer"
        }
    },
    "type": "object"
}
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

  • 12

  • 13

  • 14

  • 15

  • 16

  • 17

  • 18

  • 19

  • 20

  • 21

  • 22

  • 23

  • 24

  • 25

  • 26

  • 27

  • 28

  • 29

  • 30

  • 31

  • 32

一个完整的JSON Schema验证规范
可以根据实际情况删除一些key,但是红色标记的要保留
default默认值,根据实际情况书写,上面例子“商品库存不足时”的状态码为301,如果要对status和message的值进行验证,那么default就可以加上,如果只是验证返回的value是integer或是string类型,可以忽略
还可以加入最大值最小值等限制

下面是测试代码

var jsonData = JSON.parse(responseBody);

var schema = {
  "properties": {
    "lists": {
      "items": {
        "default": 11,
        "description": "库存不足的商品id",
        "type": "integer"
      },
      "type": "array"
    },
    "message": {
      "default": "购买商品库存不足",
      "description": "id为11的商品库存不足",
      "type": "string"
    },
    "status": {
      "description": "status",
      "type": "integer"
    }
  },
  "type": "object"
};
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

  • 12

  • 13

  • 14

  • 15

  • 16

  • 17

  • 18

  • 19

  • 20

  • 21

  • 22

  • 23

  • 24

tests["json格式验证"] = tv4.validate(jsonData, schema); //验证json格式
tests["返回状态码是200"] = responseCode.code === 200;
tests["状态码为301"] = jsonData["status"] == "301"; 
tests["message"] = jsonData["message"] == "购买商品库存不足";
tests["list"] = jsonData["lists"][0] == "11";
  • 1

  • 2

  • 3

  • 4

  • 5

这样接口返回的json结构和数据我们就可以验证了。

tv4为Postman引入的外部库,想了解的可以去看官方文档
另外Postman还提供了一些方法如:

responseCookies
request.data["key"]=="value"
request.headers["key"]=="value"
request.method
request.url
request
responseHeaders
responseBody
responseTime
responseCode 包含code,name,detail
iteration
  • 1

  • 2

  • 3

  • 4

  • 5

  • 6

  • 7

  • 8

  • 9

  • 10

  • 11

这些方法可以帮助我们做更多的事情,比如通过一个接口拿到cookie值,然后把cookie设置成全局变量,提供给其他接口使用

当我们写测试脚本时,可能会遇到脚本书写错误或是需要一些log来辅助我们完善脚本,
我们可以打开 View->Show Postman Console,打开后我们可以通过console.log(xxx)来输出日志和查看错误信息

针对一个接口,我们在知道参数以及参数对应的结果时,可以通过postman进行判断,验证返回数据是否与预期数据相等。这样可以使我们的接口测试更加的方便简洁。

 

1、准备数据。

 

postman接口测试七

 postman可以接受的文件格式如图所示,一般来说可以将我们需要进行参数化的数据存储在excel表格中,如下图所示,postman在读取数据的时候,根据第一行的列名读取,并且在excel,针对多个参数可以使用逗号隔开,没有txt那么麻烦。

 

图中,city和income是接口需要的参数,Insurance_ability和score是预期的返回的值,当然也可以跟接口返回的参数名不对应。

 

postman接口测试七

postman中读取数据的时候,会将表名默认的认为是data。所以在读取数据的时候,比如读取city这一列的数据,则书写为data.city。postman会按照data.city的读取方式读取数据直到数据为空。

 

需要注意的是:使用excel保存的数据,在保存的时候请另存为csv格式,并且使用Notepad++将其转换为utf-8的格式,不然在postman中识别是乱码格式,对数据的判断造成失误。

 

2、postman参数设置

postman接口测试七

此接口中,我们需要参数化的参数是city和income,针对这两个参数,使用{{}}包括。

 

3、请求发送前,参数设置

我们是需要对表格中的数据进行参数化,所在在发送请求之前,我们要让postman能够读取到文件中的数据,在postman中,Pre-request Script中的语句postman会在请求发送之前执行,所以读取语句的操作,我们放在这里执行。

postman接口测试七

代码语句进行读取操作。

 

var city = data.city;

var income =data.income;

4、在Tests中进行判断操作

第四步应该是最重要的操作,现在我们已经在发送请求之前读取了文件的数据,那么该如何进行判断呢?这步我们在Tests中进行,Tests会在请求之后执行,Tests也称之为断言。

 

如何去判断返回的数据是否正确的思维是:

 

1、将文件中的预期结果设置为环境变量

 

2、获取返回的数据

 

3、进行判断

 

var score=(data.score);//获取文件中数据

var Insurance_ability=(data.Insurance_ability);//设置成环境变量

pm.environment.set("score",score);

pm.environment.set("Insurance_ability",Insurance_ability);

 

 

if(tests["code is 200"]=responseCode.code===200){ //[postman断言输出,返回200打印code is 200

    var d = JSON.parse(responseBody); //将返回数据解析成json格式

if( d.得分==score&&d.保险能力==Insurance_ability){ //将返回数据与环境变量进行对比,如果同时满足

    var a=1; //因为pm.test语句中含有function()设置满足条件是a=1,

    pm.test("测试通过",function(){ //if中判断为真,则断言输入测试通过

        if(a==1);

    });

}

else{

    var a=0;

    pm.test("测试不通过",function(){

    if(a===0);

    });

}

 

}else if(tests["code is 500"]=responseCode.code===500){//状态为500时断言输出

    

}else{

    tests["code is 400"]=responseCode.code===400 //状态为400时断言输出

}

5、参数化执行

以上工作准备完成之后,我们就可以开始正式的参数化执行了

 

1、点击Runner

 

postman接口测试七

 

2、接口选择,环境准备,选择文件

 

postman接口测试七

 

3、点击Run,开始执行

 

4、检查执行结果

postman接口测试七

在数据跑完之后,我们可以直接在页面看到结果,其中pass和failed是代码tests中断言通过的数量,其中,我们可以看到测试通过,和code is 200的提示,

 

我们看到failed数量为1,我们找到该请求

postman接口测试七

看到coed is 200 状态为FALL,coed is 500状态为pass, 可以判断该请求状态码是500

 

此时就可以查看该请求的请求地址和返回参数,再对比数据,查看具体是哪里的错误。

postman接口测试七

打开请求地址和返回内容,可以看到是参数我们传递错了,该原因应该是我表格中这行数据为空,所以他直接传递的{{ciry}}和{{income}},

 

总结

以上就是如何使用postman判断返回结果是否正确的左右过程,如果有任何写的不好的地方,望指教。

 

除此之外,也遇到问题,比如在数据量大的时候,再去对比结果,就会比较麻烦,并且tests中的输出只是一个断言输出,无法通过该运行的通过或者不通过去判断有多少用例失败,所以这个是还需要研究的。

 

大家也可以通过在tests中的各种操作和打印使得自己能通过判断输出就判断出是哪里数据的问题。

 

更新

小编写了一个小时的更新,按了下谷歌的control+s,页面就崩, 小编很无奈,只能重新写。

 

之前我们已经实现了对预期数据和返回数据做一个基本的判断,但是不能简要的从运行结果查看到是通过了多少测试用例数据,没有通过多少测试用例数据,并且去查找错误数据的时候还是很麻烦。

 

查阅资料发现,针对tests语句,我们是可以设置他的结果的,就是设置通过或者不通过,所以我们新的思路就是:

 

1、对预期结果和返回结果进行判断

 

2、判断相等则设置tests语句为true

 

3、判断不相等则设置tests语句为false,即失败,并且打印参数、预期结果、实际结果,这样我们简要的从runner运行界面就知道我们那些数据不对,就不用花大量的时间查找那些数据出错。

 

语句如下:

 

tests["测试通过"]=true;   //设置为true,运行时表示pass

tests["测试不通过"]=false;  //设置为false,运行时表示fail

实现整个判断的语句如下:

 

var city = data.city;

var income =data.income;

var score=(data.score);

var Insurance_ability=(data.Insurance_ability);

pm.environment.set("score",score);

pm.environment.set("Insurance_ability",Insurance_ability);

 

var d = JSON.parse(responseBody);

 if(d.得分==score&&d.保险能力==Insurance_ability){

        tests["测试通过"]=true;

    }else{

        tests["测试不通过"+"(输入参数"+city+'、'+income+")预期结果(得分="+score+"、保险能力"+Insurance_ability+")(实际结果得分="+d.得分+"、保险能力="+d.保险能力+')']=false;

        }

如图,数据表中,存在19个用例,通过17个,失败两个,并且针对失败的用例,清晰的可以看到参数、预期结果以及返回结果。

 

postman接口测试七

 

如果数据较多的时候,我们可以直接通过运行结果页面的红色方块(失败区域)展示的用例查找失败的数据。

 

postman接口测试七

 

代码更新:

 

针对接口出现的问题,简要的分为三种情况,服务器问题、客户端问题、数据校验,所以更新了一下验证代码

 

var state=responseCode.code;//获取返回状态

var number=(state.toString()).substr(0,1);//将返回的number类型转为string类型,并获取第一位

switch(number){

case '2':

    test();

    break;

case '4':

    clientQue(); //4开头的状态,简单定义为客户端问题

    break;

case '5':

    serverQue(); //5开头的状态,简单定义为服务器问题

    break;

default:

    tests['测试不通过,状态='+state]=false;  //如出现其他情况,则打印状态,并测试不通过

    break;

}

 

function test(){ //状态为200执行的函数

var city = data.city;

var income =data.income;

var score=(data.score);  //可使用request。url获取url,解析参数字段

var Insurance_ability=(data.Insurance_ability);

 

var result = JSON.parse(responseBody);

 if(result.得分==score&&result.保险能力==Insurance_ability){

        tests["测试通过"]=true;

    }else{

        tests["测试失败"+"(输入参数"+city+'、'+income+")预期结果(得分="+score+"、保险能力"+Insurance_ability+")(实际结果得分="+result.得分+"、保险能力="+result.保险能力+')']=false;

       

        }

}

 

//客户端问题

function clientQue(){

    tests['客户端问题(请求参数或方式错误)---测试失败---状态码为'+state+'   requestURl为'+request.url]=false;

}

 

//服务器或者网关问题

function serverQue(){

    tests['服务器或网关问题---测试失败---状态码为'+state+'   requestURl为'+request.url]=false;

}

 

通过上面这些知识,我们可以解决大多数的问题,如果想更进一步,需一定的js基础