Postman使用手冊4——API test

一、Pre Request Scripts

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

prerequest script.png

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

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

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

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

注意:我們設置的環(huán)境對使用的環(huán)境變量必須是有效的。

二、Writing Tests

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


![Uploading prerequest script_871640.png . . .]


Basic structure.png

Postman給了你一個環(huán)境讓你能夠為每個request編寫、執(zhí)行你的test,而不用擔心任何額外的設置。

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

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

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

test被保存為收藏夾request的一部分,這對于后端或前端的工程師來確保API運行的正常都是非常有意義的。

2.SNIPPETS


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

3.查看結(jié)果


view result.png

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

三、Testing Sandbox

Postman的sandbox是一個JavaScript的執(zhí)行環(huán)境,這使得你能夠為request寫pre-request scripts和test scripts 。不論你寫的代碼是pre-request scripts還是test script都會在sandbox中執(zhí)行。

1.常用的庫和工具


  • 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.動態(tài)變量

Postman也有一些動態(tài)變量,你可以用在你的request中。這個現(xiàn)在主要還是在實現(xiàn)階段,更多的功能以后被被添加進來。注意:動態(tài)變量不可以用于SandBox中,你只能在request的URL、headers、body中以放在雙花括號中間的形式使用。

  • {{$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 實例

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

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

1.設置環(huán)境變量:

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

2.設置全局變量:

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

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

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

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

var jsonObject = xml2Json(responseBody);

5.檢查response的body是都為一個字符串:

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)容類型存在(檢查不區(qū)分大小寫)

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

8.內(nèi)容類型存在(區(qū)分大小寫):

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

9.response的響應時間小于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 使用手冊系列教程:


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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,363評論 6 532
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,497評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,305評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,962評論 1 311
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,727評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,193評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,257評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,411評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,945評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,777評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,978評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,519評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,216評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,642評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,878評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,657評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,960評論 2 373

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