Postman使用手冊(cè)4——API test

一、Pre Request Scripts

Postman v0.10+ 版本支持pre-request scripts。

prerequest script.png

pre-request scripts是一個(gè)關(guān)聯(lián)了收藏夾內(nèi)request，并且在發(fā)送request之前執(zhí)行的代碼片段。這對(duì)于在request header中包含時(shí)間戳或者在URL參數(shù)中發(fā)送一個(gè)隨機(jī)字符串都是非常有用的。

例如：如果要在request的header中包含一個(gè)時(shí)間戳，你可以設(shè)置一個(gè)環(huán)境變量由一個(gè)函數(shù)返回他的值。

postman.setEnvironmentVariable('timestampHeader',new Date());

你可以在header中使 timestampHeader 變量，當(dāng)request發(fā)送的時(shí)候，你的pre-request script將被執(zhí)行，這個(gè)timestampHeader 變量的值將會(huì)替換{{timestampHeader}}。

注意：我們?cè)O(shè)置的環(huán)境對(duì)使用的環(huán)境變量必須是有效的。

二、Writing Tests

1.基本結(jié)構(gòu)

![Uploading prerequest script_871640.png . . .]


Basic structure.png

Postman給了你一個(gè)環(huán)境讓你能夠?yàn)槊總€(gè)request編寫(xiě)、執(zhí)行你的test，而不用擔(dān)心任何額外的設(shè)置。

一個(gè)Postman的test本質(zhì)上是JavaScript的代碼可以用來(lái)為一些特殊的test設(shè)置值。你可以在對(duì)象中設(shè)置一個(gè)描述性的鍵作為一個(gè)元素，然后聲明他如果是true或false。

tests[“Body contains user_id”] = responseBody.has(“user_id”)

這回核對(duì)body中是否包含了user_id這個(gè)字符串。如果你需要，你可以增加更多的鍵，這取決于你要用test做多少的事情。

test被保存為收藏夾request的一部分，這對(duì)于后端或前端的工程師來(lái)確保API運(yùn)行的正常都是非常有意義的。

2.SNIPPETS

在寫(xiě)test的時(shí)候這里有些事情需要注意，Postman嘗試使得列出常用的片段更簡(jiǎn)單。你可以選擇你想添加的片段，然后適當(dāng)?shù)拇a將被添加到test的編輯器中。這是一個(gè)很好的方法來(lái)快速的構(gòu)建test

3.查看結(jié)果

view result.png

Postman在你執(zhí)行一個(gè)request的時(shí)候執(zhí)行test，當(dāng)然你可以選擇不考慮test。結(jié)果被顯示在一個(gè)tab里，并在頭部顯示多少test通過(guò)了測(cè)試。你設(shè)置在test中的變量將會(huì)被列在這里。如果值是true，這個(gè)test就會(huì)通過(guò)。你可以保持test tab活動(dòng)直到你確保所有的test執(zhí)行完。

三、Testing Sandbox

Postman的sandbox是一個(gè)JavaScript的執(zhí)行環(huán)境，這使得你能夠?yàn)閞equest寫(xiě)pre-request scripts和test scripts 。不論你寫(xiě)的代碼是pre-request scripts還是test script都會(huì)在sandbox中執(zhí)行。

1.常用的庫(kù)和工具

  • Lodash：
    JS utility library

  • jQuery (Deprecated):
    Cross-platform JavaScript library. This will be removed in future versions of the sandbox.

  • BackboneJS (Deprecated):
    Provides simple models, views, and collections. This will be removed in future versions of the sandbox.

  • SugarJS:
    Extends native JS objects with useful methods

  • tv4 JSON schema validator:
    Validates JSON objects against v4 of the json-schema draft

  • CryptoJS:
    standard and secure cryptographic algorithms. Supported algorithms: AES, DES, EvpKDF, HMAC-MD5, HMAC-SHA1/3/256/512, MD5, PBKDF2, Rabbit, SHA1/3/224/256/512, TripleDES

  • xml2Json(xmlString):
    This function behaves the same in Newman and Postman

  • xmlToJson(xmlString)(Deprecated):
    This function does NOT behave the same in Newman and Postman

  • postman.getResponseHeader(headerName) (Test-only):
    returns the response header with name "headerName", if it exists. Returns null if no such header exists. Note: According to W3C specifications, header names are case-insensitive. This method takes care of this.
    postman.getResponseHeader("Content-type") and postman.getResponseHeader("content-Type") will return the same value.

2.環(huán)境和全局變量

  • postman.setEnvironmentVariable(variableName, variableValue) : Sets an environment variable "variableName", and assigns the string "variableValue" to it. You must have an environment selected for this method to work. Note: Only strings can be stored. Storing other types of data will result in unexpected behavior.

  • postman.setGlobalVariable(variableName, variableValue):
    Sets a global variable "variableName", and assigns the string "variableValue" to it. Note: Only strings can be stored. Storing other types of data will result in unexpected behavior.

  • postman.clearEnvironmentVariable(variableName):
    Clears the environment variable named "variableName". You must have an environment selected for this method to work.

  • postman.clearGlobalVariable(variableName):
    Clears the global variable named "variableName".

  • postman.clearEnvironmentVariables():
    Clears all environment variables. You must have an environment selected for this method to work.

  • postman.clearGlobalVariables():
    Clears all global variables.

  • environment:
    A dictionary of variables in the current environment. Use environment["foo"]
    to access the value of the "foo" environment variable.

  • globals:
    A dictionary of global variables. Useglobals["bar"]
    to access the value of the "bar" global variable.

3.動(dòng)態(tài)變量

Postman也有一些動(dòng)態(tài)變量，你可以用在你的request中。這個(gè)現(xiàn)在主要還是在實(shí)現(xiàn)階段，更多的功能以后被被添加進(jìn)來(lái)。注意：動(dòng)態(tài)變量不可以用于SandBox中，你只能在request的URL、headers、body中以放在雙花括號(hào)中間的形式使用。

  • {{$guid}}: Adds a v4 style guid

  • {{$timestamp}}: Adds the current timestamp.

  • {{$randomInt}}: Adds a random integer between 0 and 1000

4. Cookies

+** responseCookies {array} **（Postman-only）:
Gets all cookies set for the domain. You will need to enable the Interceptor for this to work.

  • postman.getResponseCookie(cookieName)（Postman-only）:
    Gets the response cookie with the given name. You will need to enable the interceptor for this to work. Check out the blog post.

5.Request/response相關(guān)屬性

  • request {object}:
    Postman makes the request object available to you while writing scripts. This object is read-only. Changing properties of this object will have no effect. Note: Variables will NOT be resolved in the request object. The request object is composed of the following:

    • data {object}:
      this is a dictionary of form data for the request. (request.data["key"]=="value")

    • headers {object}:
      this is a dictionary of headers for the request (request.headers["key"]=="value")

    • method {string}:
      GET/POST/PUT etc.

    • url {string}:
      the url for the request.

  • responseHeaders {object}(Test-only)(Deprecated):
    This is a map of the response headers. This is case-sensitive, and should not be used. Check thepostman.getResponseHeader()
    method listed above.

  • responseBody {string}(Test-only):
    A string containing the raw response body text. You can use this as an input to JSON.parse, or xml2Json.

  • responseTime {number}(Test-only):
    The response time in milliseconds

  • responseCode {object}(Test-only):
    Contains three properties:

    • code {number}:
      The response code (200 for OK, 404 for Not Found etc)

    • name {string}:
      The status code text

    • detail {string}:
      An explanation of the response code

  • tests {object}(Test-only):
    This object is for you to populate. Postman will treat each property of this object as a boolean test.

  • iteration {number}:
    Only available in the Collection Runner and Newman. Represents the current test run index. Starts from 0.

(Test-only): This object is only available in the test script section. Using this in a pre-request script will throw an error.

四、Testing 實(shí)例

我們來(lái)看一些Postman用于test的例子。這些例子中的大多數(shù)在Postman中是有效的，他們像一行JavaScript語(yǔ)句一樣簡(jiǎn)答。在你的request中你可以有很多的test。

注意：test腳本在從服務(wù)器收到response后執(zhí)行

1.設(shè)置環(huán)境變量：

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

2.設(shè)置全局變量：

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

3.檢查response的body中是否包含字符串：

tests["Body matches string"] = responseBody.has("string_you_want_to_search");

4.把XML的body轉(zhuǎn)換成JSON對(duì)象：

var jsonObject = xml2Json(responseBody);

5.檢查response的body是都為一個(gè)字符串：

tests["Body is correct"] = responseBody === "response_body_string";

6.檢查JSON的值：

var data = JSON.parse(responseBody);
tests["Your test name"] = data.value === 100;

7.內(nèi)容類(lèi)型存在（檢查不區(qū)分大小寫(xiě)）

tests["Content-Type is present"] = postman.getResponseHeader("Content-Type"); //Note: the getResponseHeader() method returns the header value, if it exists.

8.內(nèi)容類(lèi)型存在（區(qū)分大小寫(xiě)）：

tests["Content-Type is present"] = responseHeaders.hasOwnProperty("Content-Type");

9.response的響應(yīng)時(shí)間小于200ms：

tests["Response time is less than 200ms"] = responseTime < 200;

10.狀態(tài)碼為200：

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

11.Code name contains a string：

tests["Status code name has string"] = responseCode.name.has("Created");

12.成功的POST request狀態(tài)碼：

tests["Successful POST request"] = responseCode.code === 201 || responseCode.code === 202;

13.Use TinyValidator 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);

14.Sample data files

JSON files are composed of key/value pairs：

Download JSON file

For CSV files, the top row needs to contain variable names

Download CSV file

Postman 使用手冊(cè)系列教程：

Postman軟件安裝
Postman使用手冊(cè)1——導(dǎo)入導(dǎo)出和發(fā)送請(qǐng)求查看響應(yīng)
Postman使用手冊(cè)2——管理收藏
Postman使用手冊(cè)3——環(huán)境變量
Postman使用手冊(cè)4——API test

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容

  • PLEASE READ THE FOLLOWING APPLE DEVELOPER PROGRAM LICENSE...
    念念不忘的閱讀 13,551評(píng)論 5贊 6
  • **2014真題Directions:Read the following text. Choose the be...
    又是夜半驚坐起閱讀 9,934評(píng)論 0贊 23
  • 這是預(yù)覽模式標(biāo)題 一級(jí)標(biāo)題 二級(jí)標(biāo)題 三級(jí)標(biāo)題 四級(jí)標(biāo)題 五級(jí)標(biāo)題 六級(jí)標(biāo)題 列表 無(wú)序列表 文本1 文本2 文本...
    JUN0508閱讀 247評(píng)論 0贊 0
  • 喜歡他的第587天. 時(shí)間過(guò)得很快，轉(zhuǎn)眼就要各奔東西。他曾經(jīng)說(shuō)過(guò)我們不會(huì)分開(kāi)，可命運(yùn)又能被誰(shuí)左右。他說(shuō)過(guò)，只要走進(jìn)...
    拯救地球的洛閱讀 364評(píng)論 0贊 1
  • 大家晚上好。不二法門(mén)的朋友這兩天剛突破一千的數(shù)目。只是單純地想謝謝大家的支持。 我知道這個(gè)數(shù)目對(duì)于一個(gè)公眾號(hào)來(lái)說(shuō)小...
    郭綠獅閱讀 263評(píng)論 0贊 1