接口調(diào)試工具Postman的具體使用方法

一 簡(jiǎn)介 Postman 是一款功能超級(jí)強(qiáng)大的用于發(fā)送 HTTP 請(qǐng)求的 Chrome插件 。做web頁(yè)面開發(fā)和測(cè)試的人員應(yīng)該是無人不曉無人不用！其主要特點(diǎn) 特點(diǎn)： 創(chuàng)建 + 測(cè)試：創(chuàng)建和發(fā)送任何的HTTP請(qǐng)求

一 簡(jiǎn)介

Postman是一款功能超級(jí)強(qiáng)大的用于發(fā)送 HTTP 請(qǐng)求的 Chrome插件 。做web頁(yè)面開發(fā)和測(cè)試的人員應(yīng)該是無人不曉無人不用！其主要特點(diǎn)特點(diǎn)：
創(chuàng)建 + 測(cè)試：創(chuàng)建和發(fā)送任何的HTTP請(qǐng)求，請(qǐng)求可以保存到歷史中再次執(zhí)行
Organize:使用Postman Collections為更有效的測(cè)試及集成工作流管理和組織APIs
document:依據(jù)你創(chuàng)建的Clollections自動(dòng)生成API文檔,并將其發(fā)布成規(guī)范的格式
collarorate:通過同步連接你的team和你的api，以及權(quán)限控制，API庫(kù)

準(zhǔn)備

1. 下載安裝postman（具體安裝方法這里不贅述，見http://www.cnplugins.com/devtool/postman/）

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

有時(shí)需要在不同的環(huán)境下跑相同的測(cè)試，此時(shí)可以通過設(shè)置環(huán)境變量來動(dòng)態(tài)選擇。點(diǎn)擊右上角的設(shè)置按鈕：

填寫該環(huán)境的名稱：如測(cè)試環(huán)境，并在key和value中填寫需要的鍵值

使用這些鍵值的時(shí)候只需要加上兩個(gè)花括號(hào)引用key

1 {{url_base}}/username

解析完后

建立多個(gè)環(huán)境時(shí)，key通常都是相同的，只是value不同

創(chuàng)建好所有環(huán)境后，在跑用例的時(shí)候在右上角下拉列表選擇需要的環(huán)境就好

二 請(qǐng)求

  • postman界面分為兩部分：左邊的sidebar 右邊的request builder：快速創(chuàng)建幾乎所有的請(qǐng)求

    image

  • HTTP請(qǐng)求的4部分:URL，請(qǐng)求的method，headers，body。

    image

    • URL

      首先需要設(shè)置的就是URL

      image

      注意：如果在輸入?yún)?shù)時(shí)，沒有自動(dòng)decode到URL中，則可以選中參數(shù)右鍵后，選擇EncodeURIComponent（一般都會(huì)自動(dòng)填充的）：

      image

      同樣也可以decode，將參數(shù)生成dictionary的形式（一般都會(huì)自動(dòng)填充的）：

      image

      有的URL中有path變量，postman可以自動(dòng)提取該path變量為一個(gè)key

      image

      點(diǎn)擊headers toggle：

      image

      輸入key-value時(shí)，會(huì)有自動(dòng)提示的下拉面板：

      image

有些headers和cookies是保密的，如：

1.Accept-Charset
2.Accept-Encoding 
3.Access-Control-Request-Headers
4.Access-Control-Request-Method
5.Connection
6.Content-Length
7.Cookie
8.Cookie 2
9.Content-Transfer-Encoding
10.Date
11.Expect
12.Host
13.Keep-Alive
14.Origin
15.Referer
16.TE
17.Trailer
18.Transfer-Encoding
19.Upgrade
20.User-Agent
21.Via

postman 0.9.6版本后，這些限制可以解除：
點(diǎn)擊右上角的Interceptor 安裝這個(gè)：

image

  • cookies

    分開打包的應(yīng)用程序運(yùn)行在沙箱瀏覽器,它不能訪問cookie設(shè)置瀏覽器內(nèi)。這種限制也可以使用攔截器擴(kuò)展。

  • Method

    image

  • Request body

    image
    • 不同的body editor 分為4個(gè)區(qū)域,根據(jù)body類型有不同的控制。
      image
    • mutipart/form-data是網(wǎng)頁(yè)表單用來傳輸數(shù)據(jù)的默認(rèn)格式?？梢阅M填寫表單，并且提交表單。

      可以上傳一個(gè)文件作為key的value提交(如上傳文件)。但該文件不會(huì)作為歷史保存，只能在每次需要發(fā)送請(qǐng)求的時(shí)候，重新添加文件。

      image

  • 2 urlencoded

    同前面一樣，注意,你不能上傳文件通過這個(gè)編碼模式。
    該模式和表單模式會(huì)容易混淆。urlencoded中的key-value會(huì)寫入U(xiǎn)RL，form-data模式的key-value不明顯寫入U(xiǎn)RL，而是直接提交。

  • 3 raw

    raw request可以包含任何東西。所有填寫的text都會(huì)隨著請(qǐng)求發(fā)送。

    [圖片上傳失敗...(image-18ffd9-1545145663657)]

  • 4 binary

    image, audio or video files.text files 。 也不能保存歷史，每次選擇文件，提交。

三 響應(yīng)

保證API響應(yīng)的正確性，就是你需要做的大部分工作。postman的response viewer部分會(huì)協(xié)助你完成該工作且使其變得簡(jiǎn)單。
一個(gè)API的響應(yīng)包含body,headers,響應(yīng)狀態(tài)碼。postman將body和headers放在不同的tabs中。響應(yīng)碼和響應(yīng)時(shí)間顯示在tabs的旁邊。將鼠標(biāo)懸停在響應(yīng)碼上面可以查看更詳細(xì)的信息。

1 保存responses

image

2 查看responses

三種視圖查看body：

image

  • Pretty

    格式化了JSON和XML，方便查看。 點(diǎn)擊里面的URL，postman會(huì)創(chuàng)建一個(gè)request：

    image

    點(diǎn)擊左邊的三角可以折疊展開：

    image

    postman自動(dòng)格式化body必須保證返回了正確的Content-Type.如果API沒有返回，則可以點(diǎn)擊”Force JSON“來設(shè)置。

    image

  • Raw

    是text。

  • preview

    有的瀏覽器會(huì)返回HTML的錯(cuò)誤，對(duì)于找問題比較方便。由于sandbox的限制，js和圖片不會(huì)顯示在這里的iframe中。你可以maximize該body窗口方便查看結(jié)果。
    Headers key-value形式展示。鼠標(biāo)懸停在headers標(biāo)簽上，有詳細(xì)的HTTP說明。

  • cookies

    可以顯示browser cookies，需要開啟Interceptor。

  • 身份驗(yàn)證Authentication

    postman有一個(gè)helpers可以幫助我們簡(jiǎn)化一些重復(fù)和復(fù)雜的任務(wù)。當(dāng)前的一套helpers可以幫助你解決一些authentication protocols的問題。

    image

  • Basic Auth

    填寫用戶名和密碼，點(diǎn)擊Refresh headers

  • Digest Auth

    要比Basic Auth復(fù)雜的多。使用當(dāng)前填寫的值生成authorization header。所以在生成header之前要確保設(shè)置的正確性。如果當(dāng)前的header已經(jīng)存在，postman會(huì)移除之前的header。

  • OAuth 1.0a

    postman的OAuth helper讓你簽署支持OAuth 1.0基于身份驗(yàn)證的請(qǐng)求。OAuth不用獲取access token,你需要去API提供者獲取的。OAuth 1.0可以在header或者查詢參數(shù)中設(shè)置value。

  • OAuth 2.0

    postman支持獲得OAuth 2.0 token并添加到requests中。

四 Writting Test

Postman的Tests標(biāo)簽可以用來寫測(cè)試：

image

本質(zhì)上是javascript code，可以為tests object設(shè)置values。
這里使用描述性文字作為key，檢驗(yàn)body中的各種情況，當(dāng)然你可以創(chuàng)建任意多的key，這取決于你需要測(cè)試多少點(diǎn)。
tests也會(huì)隨著request保存到collection中。api測(cè)試保證前端后臺(tái)都能正常的于api協(xié)作工作，而不用在出錯(cuò)時(shí)猜測(cè)是哪里的問題。
需要在request的test中創(chuàng)建了test后，再進(jìn)行request，test的結(jié)果在body的test中查看。
注意：
1.這里的key描述必須是唯一的，否則相同描述只會(huì)執(zhí)行第一個(gè)。
2.這里的key可以使用中文。
例子： tests[“Body contains user_id”] = responseBody.has(“user_id”)
這里描述性的key為：Body contains user_id。檢測(cè)點(diǎn)為：responseBody.has(“user_id”)，意思是檢測(cè)返回的body中是否包含”user_id”這個(gè)字段。
查看responses中的Tests結(jié)果：記過顯示每個(gè)key,也就是我們測(cè)試點(diǎn)的具體結(jié)果，是否通過。

image

  • Testing Sandbox

    postman的測(cè)試是運(yùn)行在沙箱環(huán)境，是與app獨(dú)立的。查看什么在沙箱中是可用的，參見Sandbox documentation.

  • Snippets

    用于快速添加常用的測(cè)試代碼?？梢宰远xsnippets。

    image

  • Viewing results

    postman每次執(zhí)行request的時(shí)候，會(huì)執(zhí)行tests。測(cè)試結(jié)果會(huì)在tests的tab上面顯示一個(gè)通過的數(shù)量。

  • Testing Sandbox

  • Testing examples

    測(cè)試代碼會(huì)在發(fā)送request并且接收到responses后執(zhí)行。

    • 1.設(shè)置環(huán)境變量 postman.setEnvironmentVariable("key", "value");

    • 2.設(shè)置全局變量 postman.setGlobalVariable("key", "value");

    • 3.檢查response body中是否包含某個(gè)string tests["Body matches string"] =responseBody.has
      ("string_you_want_to_search");

    • 4.檢測(cè)JSON中的某個(gè)值是否等于預(yù)期的值
      var data = JSON.parse(responseBody);tests["Your test name"] = data.value === 100;
      JSON.parse()方法，把json字符串轉(zhuǎn)化為對(duì)象。parse()會(huì)進(jìn)行json格式的檢查是一個(gè)安全的函數(shù)。 如：檢查json中某個(gè)數(shù)組元素的個(gè)數(shù)(這里檢測(cè)programs的長(zhǎng)度)
      var data = JSON.parse(responseBody);tests["program's lenght"] = data.programs.length === 5;

    • 5.轉(zhuǎn)換XML body為JSON對(duì)象 var jsonObject = xml2Json(responseBody);

    • 6.檢查response body是否與某個(gè)string相等 tests["Body is correct"] = responseBody === "response_body_string";

    • 7.測(cè)試response Headers中的某個(gè)元素是否存在(如:Content-Type)
      tests["Content-Type is present"] = postman.getResponseHeader("Content-Type"); //getResponseHeader()方法會(huì)返回header的值，如果該值存在
      或者：
      tests["Content-Type is present"] = responseHeaders.hasOwnProperty("Content-Type");
      上面的方法，不區(qū)分大小寫。下面的方法，要區(qū)分大小寫。

      image

    • 8.驗(yàn)證Status code的值 tests["Status code is 200"] = responseCode.code === 200;

    • 9.驗(yàn)證Response time是否小于某個(gè)值 tests["Response time is less than 200ms"] = responseTime < 200;

    • 10.name是否包含某個(gè)值 tests["Status code name has string"] = responseCode.name.has("Created");

    • 11.POST 請(qǐng)求的狀態(tài)響應(yīng)碼是否是某個(gè)值 tests["Successful POST request"] = responseCode.code === 201 || responseCode.code === 202;

    • 12.很小的JSON數(shù)據(jù)驗(yàn)證器
      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);
      結(jié)果：

      image

五 運(yùn)行Collections

postman允許你運(yùn)行collection，你可以運(yùn)行任意的次數(shù)。 最后會(huì)給出一個(gè)整體運(yùn)行的結(jié)果。會(huì)保存每一次運(yùn)行的結(jié)果，提供給你比較每一次運(yùn)行解雇的不同。
選擇collection，選擇環(huán)境。點(diǎn)擊運(yùn)行按鈕。

image

在需要csv和json文件的地方記得添加。
運(yùn)行collection測(cè)試會(huì)在另一個(gè)窗口運(yùn)行。如果需要在main窗口修改東西，在新窗口能正常讀取。

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容