使用 postman 给 API 写测试

使用 postman 给 API 写测试

Intro

上次我们简单介绍了 使用 postman 测试 API，这次主要来写一些测试用例以检查请求的响应是否符合我们的预期以及如何使用脚本测试

使用 postman 内置的随机变量

postman 内置的有一些产生随机值的变量，在发送请求时随机生成，这样我们可以在请求中随机生成一些用户名，邮箱，公司名称等等，

支持的变量如下，官方文档：https://learning.getpostman.com/docs/postman/variables-and-environments/variables-list/

  • {{$randomZipCode}}
  • {{$randomCity}}
  • {{$randomCityPrefix}}
  • {{$randomCitySuffix}}
  • {{$randomStreetName}}
  • {{$randomStreetAddress}}
  • {{$randomStreetSuffix}}
  • {{$randomStreetPrefix}}
  • {{$randomSecondaryAddress}}
  • {{$randomCountry}}
  • {{$randomCountryCode}}
  • {{$randomState}}
  • {{$randomStateAbbr}}
  • {{$randomLatitude}}
  • {{$randomLongitude}}
  • {{$randomColor}}
  • {{$randomDepartment}}
  • {{$randomProductName}}
  • {{$randomPrice}}
  • {{$randomProductAdjective}}
  • {{$randomProductMaterial}}
  • {{$randomProduct}}
  • {{$randomCompanyName}}
  • {{$randomCompanySuffix}}
  • {{$randomCatchPhrase}}
  • {{$randomBs}}
  • {{$randomCatchPhraseAdjective}}
  • {{$randomCatchPhraseDescriptor}}
  • {{$randomCatchPhraseNoun}}
  • {{$randomBsAdjective}}
  • {{$randomBsBuzz}}
  • {{$randomBsNoun}}
  • {{$randomDatabaseColumn}}
  • {{$randomDatabaseType}}
  • {{$randomDatabaseCollation}}
  • {{$randomDatabaseEngine}}
  • {{$randomDatePast}}
  • {{$randomDateFuture}}
  • {{$randomDateBetween}}
  • {{$randomDateRecent}}
  • {{$randomMonth}}
  • {{$randomWeekday}}
  • {{$randomBankAccount}}
  • {{$randomBankAccountName}}
  • {{$randomCreditCardMask}}
  • {{$randomCurrencyAmount}}
  • {{$randomTransactionType}}
  • {{$randomCurrencyCode}}
  • {{$randomCurrencyName}}
  • {{$randomCurrencySymbol}}
  • {{$randomBitcoin}}
  • {{$randomBankAccountIban}}
  • {{$randomBankAccountBic}}
  • {{$randomAbbreviation}}
  • {{$randomAdjective}}
  • {{$randomNoun}}
  • {{$randomVerb}}
  • {{$randomIngverb}}
  • {{$randomPhrase}}
  • {{$randomImage}}
  • {{$randomAvatarImage}}
  • {{$randomImageUrl}}
  • {{$randomAbstractImage}}
  • {{$randomAnimalsImage}}
  • {{$randomBusinessImage}}
  • {{$randomCatsImage}}
  • {{$randomCityImage}}
  • {{$randomFoodImage}}
  • {{$randomNightlifeImage}}
  • {{$randomFashionImage}}
  • {{$randomPeopleImage}}
  • {{$randomNatureImage}}
  • {{$randomSportsImage}}
  • {{$randomTechnicsImage}}
  • {{$randomTransportImage}}
  • {{$randomImageDataUri}}
  • {{$randomEmail}}
  • {{$randomExampleEmail}}
  • {{$randomUserName}}
  • {{$randomProtocol}}
  • {{$randomUrl}}
  • {{$randomDomainName}}
  • {{$randomDomainSuffix}}
  • {{$randomDomainWord}}
  • {{$randomIP}}
  • {{$randomIPV6}}
  • {{$randomUserAgent}}
  • {{$randomHexColor}}
  • {{$randomMACAddress}}
  • {{$randomPassword}}
  • {{$randomLoremWord}}
  • {{$randomLoremWords}}
  • {{$randomLoremSentence}}
  • {{$randomLoremSlug}}
  • {{$randomLoremSentences}}
  • {{$randomLoremParagraph}}
  • {{$randomLoremParagraphs}}
  • {{$randomLoremText}}
  • {{$randomLoremLines}}
  • {{$randomFirstName}}
  • {{$randomLastName}}
  • {{$randomFullName}}
  • {{$randomJobTitle}}
  • {{$randomNamePrefix}}
  • {{$randomNameSuffix}}
  • {{$randomNameTitle}}
  • {{$randomJobDescriptor}}
  • {{$randomJobArea}}
  • {{$randomJobType}}
  • {{$randomPhoneNumber}}
  • {{$randomPhoneNumberFormat}}
  • {{$randomPhoneFormats}}
  • {{$randomArrayElement}}
  • {{$randomObjectElement}}
  • {{$randomUUID}}
  • {{$randomBoolean}}
  • {{$randomWord}}
  • {{$randomWords}}
  • {{$randomLocale}}
  • {{$randomAlphaNumeric}}
  • {{$randomFileName}}
  • {{$randomCommonFileName}}
  • {{$randomMimeType}}
  • {{$randomCommonFileType}}
  • {{$randomCommonFileExt}}
  • {{$randomFileType}}
  • {{$randomFileExt}}
  • {{$randomDirectoryPath}}
  • {{$randomFilePath}}
  • {{$randomSemver}}

还是比较偏英文化，对于中文可能并不太友好，下面来演示一个使用示例：

在请求中使用上面这些变量

监控发送的 HTTP 请求

从上图中可以看到，我们使用到的随机变量在发送请求的时候是已经替换成具体的值的了

编写测试用例

Scripts 介绍

postman 有一套基于 nodejs 的运行时，我们可以写一些 scripts 来在请求发送之前做一些日志等，在得到响应之后测试响应是否与预期一致

postman 的 script 主要分成两类，一类是 Pre-Request Scripts，在发送请求之前执行，一类是 Tests，个人感觉可能叫 Post-Response Scripts 更好一些，因为我们不仅仅可以写测试，也可以记录日志，也可以设置变量等

上次我们说过了 postman 的测试推荐使用 Collection ，Collection 下可以分目录也可以直接就是 request，目录里也可以有具体的 api request，还可以有子目录

Collection/Folder/Request 都可以定义自己的 Pre-Request Scripts 和 Tests，这些 Scripts 执行顺序如下：

上一级的测试作用于子级所有的请求，也就是说我们可以在 Collection 的 Test Scripts 中定义一个测试用例，这会对这个 Collection 下的所有请求都有效，都会验证这个测试是否有效

如果想要实现测试用例的复用可以将类似的请求放在一个目录下针对目录写测试用例，这样这个目录下的请求都会有这个测试用例

如果只是想针对某一个请求的测试，可以针对 request 来写，只在对应 request 的 Test Scripts 中定义即可

Scripts 常用语法

Postman Console

postman 是基于 nodejs 的，你可以直接使用 console.log 来记录一些日志，通过 postman console 来查看，在左上角的菜单 View 下有一个 Show Postman Console

我们在请求的 Pre-Scripts 里输出一条日志，然后发送请求

这里的 pm.variables.set("phone","") 是设置 phone 这一参数为空字符串，由下图可以看出，phone 这一变量在发送请求的时候会被替换成空字符串

查看 postman console

可以看到我们在上面输出的日志已经输出到 postman console 了

变量设置

postman 支持的变量分几个层级，

  • global
  • environment
  • collection
  • data(数据文件中的变量值）
  • local

变量优化级：

上面的类型优先级从低到高，“就近原则”

// Variables
// This function searches for the variable across globals and the active environment.
var value = pm.variables.get("variable_key"); // 这个方法会从上面所有的来源寻找对应的变量，就近原则，优先从最靠近自己的地方找

// Globals
// Set a global variable，设置一个全局变量
pm.globals.set("variable_key", "variable_value");
// Get a global variable，从全局变量中获取某个变量的值
pm.globals.get("variable_key");
// Clear a global variable，取消设置全局变量，移除变量
pm.globals.unset("variable_key");

// Environments
// Setting an environment variable, 设置一个环境变量（注，这是postman 中的 <Environment> 环境变量，不同于系统环境变量)
pm.environment.set("variable_key", "variable_value");

// 你也可以序列化一个对象或数组放在变量中
// Setting a nested object as an environment variable
// var array = [1, 2, 3, 4];
// pm.environment.set("array", JSON.stringify(array, null, 2));
// var obj = { a: [1, 2, 3, 4], b: { c: 'val' } };
// pm.environment.set("obj", JSON.stringify(obj));

// Getting an environment variable，从环境中获取某个变量
var value = pm.environment.get("variable_key");

// If the value is a stringified JSON:
// These statements should be wrapped in a try-catch block if the data is coming from an unknown source.
var array = JSON.parse(pm.environment.get("array"));
var obj = JSON.parse(pm.environment.get("obj"));

// // Clear an environment variable, 从环境中移除某一个变量
// pm.environment.unset("variable_key");

// Collection

// Setting an collection variable，设置一个 collection 变量
pm.collectionVariables.set("variable_key", "variableValue");
// Get a collection variable，从 collection 中获取一个变量
var val = pm.collectionVariables.get("variable_key");
// Clear a collection variable，从 collection 中移除一个变量
pm.collectionVariables.unset("variable_key");

// local
pm.variables.set("variable_key", "variable_value");

pm.variables.get("variable_key");

使用变量，如 username => {{username}}，使用两层大括号来表示变量引用，比如上面的测试中的 phone

测试用例

postman 的测试用例也是分层级的，上面已经做了简单的介绍，postman 是基于 nodejs 的所以，在nodejs 里可以用的语法大多也都支持，比如 JSON.parse，这里主要介绍几种常用的方法：

// 检查 response 的 statusCode 是 200
pm.test("response is ok", function () {
    pm.response.to.have.status(200);
});

// 检查响应是 200，并且有 body，body 是一个 json
pm.test("response must be valid and has a json body", function () {
     // assert that the status code is 200
     pm.response.to.be.ok; // info, success, redirection, clientError,  serverError, are other variants
     // assert that the response has a valid JSON body
     pm.response.to.be.withBody;
     pm.response.to.be.json; // this assertion also checks if a body  exists, so the above check is not needed
});

// 定义一个超时时间，检查响应时间是否超时
let responseTimeout = parseInt(pm.variables.get("responseTimeout"));
if(responseTimeout > 0){
    pm.test(`Response time is less than ${responseTimeout}ms`, function () {
        pm.expect(pm.response.responseTime).to.be.below(responseTimeout);
    });
}

// Convert XML body to a JSON object，使用postman 内置的 xml2Json 将 xml 转换为 json 对象
var jsonObject = xml2Json(responseBody);

//Check for a JSON value
// 检查 json 对象中某一个值是否符合预期
pm.test("Your test name", function () {
    var jsonData = pm.response.json();
    pm.expect(jsonData.value).to.eql(100);
});

// 检查数组是否为空
pm.test("Check if array is empty", function () {
 expect([]).to.be.empty;
});

// 检查字符串是否为空
pm.test("Check if string is empty", function () {
 pm.expect('').to.be.empty;
});

运行测试：

测试结果会显示出多个测试通过，多少失败的，哪些 assertion 失败，你也可以看到具体的响应信息

使用命令行测试

postman 提供了一个 npm 包 newman，我们可以直接命令行运行测试，也可以在自己的程序里集成 npm 包，在程序里运行

npm install -g newman

使用导出 Collection， 导出之后是一个 json 文件

newman run testCollection.json // 运行 testCollection 测试

newman run testCollection.json -d testData.json // -d 指定数据文件

newman run testCollection.json -d testData.json -r json // -d 指定数据文件，-r 指定 report 类型，默认是 `cli` 直接在命令行中输出测试结果

newman run testCollection.json -r cli,json // -d 指定数据文件，-r 指定 report 类型，默认是 `cli` 直接在命令行中输出测试结果，可以指定多个 reporter，json 会将运行结果保存到 json 文件中

// collection 路径不仅支持本地路径，也支持 url
newman run https://www.getpostman.com/collections/631643-f695cab7-6878-eb55-7943-ad88e1ccfd65-JsLv

示例：

在自己的程序中使用 newman 运行测试

const newman = require('newman'); // require newman in your project

// call newman.run to pass `options` object and wait for callback
newman.run({
    collection: require('./sample-collection.json'),
    reporters: 'cli'
}, function (err) {
    if (err) { throw err; }
    console.log('collection run complete!');
});

更多用法参考官方文档：https://github.com/postmanlabs/newman#using-newman-cli

Reference

原文地址：https://www.cnblogs.com/weihanli/p/write-test-cases-for-api-with-postman.html

时间： 2024-10-05 05:50:04

使用 postman 给 API 写测试的相关文章

使用Tcl脚本调用STC平台的Native API实现测试对象、Device、StreamBlock的创建和配置

环境配置如下: 在Windows的Conmand下操作 # # Configuration file(CommonConFig.tcl) # # Initializing the Script. # This script is used to set common configuration paramters used with the STC-300 class. #Step 1: Load Spirent TestCenter Automation API. # Type in the

写测试感悟，获取软件测试学习视频资料

大家好,我是TT,互联网测试行业多年,没有牛逼的背景,也没有什么可炫耀的,唯独比他人更努力,在职场打拼.遇到过的坑,走过的弯路,愿意与大家分享,分享自己的经验,少走弯路.首发于个人公众号[测试架构师] 原文如下: 今天重新系统的整理了一些学习资料,电子书,视频教程等!以活动参与方式发放. 活动规则: 从个人角度,简单聊聊软件测试,自己对软件测试的思考.通过文章底部的评论区留言(微信公众号测试架构师),活动结束将发送给点赞最高的前10名读者.   获取方式有两种: 1.文章底部评论区留言方式,点赞

改进Threadglog并增加多线程写测试

写了个objectpool,很简单,就是个线程安全的队列. #pragma once #include <iostream> #include <concurrent_vector.h> #include <concurrent_queue.h> #include <algorithm> template <typename T> class ObjectPool { public: ObjectPool(size_t chunk_size =

web api写api接口时返回

web api写api接口时默认返回的是把你的对象序列化后以XML形式返回,那么怎样才能让其返回为json呢,下面就介绍两种方法: 方法一:(改配置法) 找到Global.asax文件,在Application_Start()方法中添加一句: 复制代码 代码如下: GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear(); 修改后: 复制代码 代码如下: protected void

程序员自己写测试，还要测试人员做什么？

在向开发人员介绍单元测试或TDD等工程实践时,往往可以听到这样的疑问.比如: 自己写的程序,自己无法从另一个角度测出问题.写bug的时间都不够了,哪有时间来写测试?开发来写测试了,测试干什么?除了核心代码,没有什么值得测试的.-- 一个例子首先我们看一个例子. 全项目唯一的测试 不止一次,我在各种项目中看到这样的测试,往往这也是整个工程中唯一一个测试.可以看出,开发者认为编写是有必要的.所以按照"标准"的做法建立了测试目录,引入JUnit依赖.并且利用它在开发的初期来验证某些技术疑问,

Nodejs开源项目里怎么样写测试、CI和代码测试覆盖率

测试 目前主流的就bdd和tdd,自己查一下差异 推荐 mocha和tape 另外Jasmine也挺有名,angularjs用它,不过挺麻烦的,还有一个选择是qunit,最初是为jquery测试写的,在nodejs里用还是觉得怪怪的. 如果想简单可以tap,它和tape很像,下文会有详细说明 mocha mocha是tj写的 https://github.com/mochajs/mocha var assert = require("assert") describe('truth',

如何在Chrome下使用Postman进行rest请求测试

在web和移动端开发时,常常会调用服务器端的restful接口进行数据请求,为了调试,一般会先用工具进行测试,通过测试后才开始在开发中使用.这里介绍一下如何在chrome浏览器利用postman应用进行restful api接口请求测试. 工具/原料 chrome浏览器 postman 1.安装Postman 1 下载postman,这里提供两种方式. 1.通过postman官方网站直接点击百度搜索"postman" 就可以找到. 点击"get it now it's fre

【基于Puppeteer前端自动化框架】【二】PO模式，断言（如何更简便逻辑的写测试代码）

一.概要 前面介绍了Puppeteer+jest+TypeScript做UI自动化,但是这知识基础的,我们实现自动化要考虑的很多,比如PO模式,比如配置文件,比如断言等等.下面就来一一实现我是怎么用puppeteer 做UI自动化的 二.断言 (一)需要依赖的安装包 依赖包 命令 Jest npm install jest --save-dev @types/jest npm install @types/jest --save-dev expect-puppeteer npm install

何时该开始写测试代码

当你想把一些东西写到 print 语句或者调试表达式中时,别这么做,将其写成一个测试来代替. --Martin Fowler 单元测试主要是作为一种良好实践来编写的,它能帮助开发人员识别并修复 bug.重构代码,还可以看作被测软件单元的文档.要实现这些好处,理想的单元测试应当覆盖程序中所有可能的路径.一个单元测试通常覆盖一个函数或方法中 的一个特定路径.但是,测试方法并不一定非要是一个封装良好的独立实体.测试方法之间经常有隐含的依赖关系暗藏在测试的实现方案中. --Adrian Kuhn et.