轉自:http://blog.csdn.net/flowerspring/article/details/52774399
Postman用法簡介
Postman用法簡介-Http請求模擬工具
在我們平時開發中,特別是需要與接口打交道時,無論是寫接口還是用接口,拿到接口后肯定都得提前測試一下,這樣的話就非常需要有一個比較給力的Http請求模擬工具,現在流行的這種工具也挺多的,像火狐瀏覽器插件-RESTClient,Chrome瀏覽器插件-Postman等等。這里主要介紹一下Postman。
一、Postman說明
Postman是一種網頁調試與發送網頁http請求的chrome插件。我們可以用來很方便的模擬get或者post或者其他方式的請求來調試接口。
二、安裝(安裝到chrome插件)
在安裝時,最好是通過chrome瀏覽器打開chrome網上應用店直接添加到chrome插件中。如果是直接從網上先把postman下載好很可能按不到chrome上去。
進入chrome網上應用店需要FQ,在這里默認你可以FQ,大體步驟如下:
- 打開chrome瀏覽器的chrome網上應用店,搜索postman。
- 點擊添加至CHROME。
三、基本使用方法
說明:在這里以一個提交多層嵌套的json數據格式的post請求為例。
如:
1 data= 2 { 3 "xxx": 4 { 5 "xxx": "xxxxxxxxxxx", 6 "xxx": "xxxxxxxxxxx" 7 }, 8 "aaa": "xxxxxxxxxxx", 9 "bbb": "xxxxxxxxxxx", 10 "ccc": "xxxxxxxxxxx" 11 }
1、在chrome中安裝好postman插件后,通常會在桌面上生成一個Postman的快捷方式,再次打開它時可以直接通過快捷方式也可以在chrome瀏覽器中的應用中打開它,我們會看到如下界面:
2、打開后,在紅圈里面輸入需要測試的接口地址,選擇post方式,然后在下面的Headers中手動添加一個相應的鍵值。這個很關鍵,一定要填寫正確。
(如:json格式的提交數據需要添加:Content-Type :application/x-www-form-urlencoded,否則會導致請求失敗)
如圖:
3、選擇Body選項卡,然后選中row,在編輯框中輸入你需要提交的參數即可:
4、點擊Send即可提交請求,然后在下面查看請求結果,並且可以以Pretty、Raw、Preview三種方式查看。如圖:
注:本篇文檔只是簡單舉了個列子滿足我們日常測試即可,更多的細節可登錄Postman官方網站:https://www.getpostman.com
Postman 使用詳解
閱讀 6754收藏 3022016-6-9
一 簡介
特點:
- 創建 + 測試:創建和發送任何的HTTP請求,請求可以保存到歷史中再次執行
- Organize:使用Postman Collections為更有效的測試及集成工作流管理和組織APIs
- document:依據你創建的Clollections自動生成API文檔,並將其發布成規范的格式
- collarorate:通過同步連接你的team和你的api,以及權限控制,API庫
二 請求
postman界面分為兩部分:左邊的sidebar 右邊的request builder:快速創建幾乎所有的請求
HTTP請求的4部分:URL,請求的method,headers,body。
URL
首先需要設置的就是URL
注意:如果在輸入參數時,沒有自動decode到URL中,則可以選中參數右鍵后,選擇EncodeURIComponent(一般都會自動填充的):
同樣也可以decode,將參數生成dictionary的形式(一般都會自動填充的):
有的URL中有path變量,postman可以自動提取該path變量為一個key
點擊headers toggle:
輸入key-value時,會有自動提示的下拉面板:
有些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版本后,這些限制可以解除:
點擊右上角的Interceptor 安裝這個:
cookies
分開打包的應用程序運行在沙箱瀏覽器,它不能訪問cookie設置瀏覽器內。這種限制也可以使用攔截器擴展。
Method
Request body
不同的body editor 分為4個區域,根據body類型有不同的控制。
mutipart/form-data是網頁表單用來傳輸數據的默認格式。可以模擬填寫表單,並且提交表單。
可以上傳一個文件作為key的value提交(如上傳文件)。但該文件不會作為歷史保存,只能在每次需要發送請求的時候,重新添加文件。
2 urlencoded
同前面一樣,注意,你不能上傳文件通過這個編碼模式。
該模式和表單模式會容易混淆。urlencoded中的key-value會寫入URL,form-data模式的key-value不明顯寫入URL,而是直接提交。
3 raw
raw request可以包含任何東西。所有填寫的text都會隨着請求發送。
4 binary
image, audio or video files.text files 。 也不能保存歷史,每次選擇文件,提交。
三 響應
保證API響應的正確性,就是你需要做的大部分工作。postman的response viewer部分會協助你完成該工作且使其變得簡單。
一個API的響應包含body,headers,響應狀態碼。postman將body和headers放在不同的tabs中。響應碼和響應時間顯示在tabs的旁邊。將鼠標懸停在響應碼上面可以查看更詳細的信息。
1 保存responses
2 查看responses
三種視圖查看body:
Pretty
格式化了JSON和XML,方便查看。 點擊里面的URL,postman會創建一個request:
點擊左邊的三角可以折疊展開:
postman自動格式化body必須保證返回了正確的Content-Type.如果API沒有返回,則可以點擊”Force JSON“來設置。
Raw
是text。
preview
有的瀏覽器會返回HTML的錯誤,對於找問題比較方便。由於sandbox的限制,js和圖片不會顯示在這里的iframe中。你可以maximize該body窗口方便查看結果。
Headers key-value形式展示。鼠標懸停在headers標簽上,有詳細的HTTP說明。
cookies
可以顯示browser cookies,需要開啟Interceptor。
身份驗證Authentication
postman有一個helpers可以幫助我們簡化一些重復和復雜的任務。當前的一套helpers可以幫助你解決一些authentication protocols的問題。
Basic Auth
填寫用戶名和密碼,點擊Refresh headers
Digest Auth
要比Basic Auth復雜的多。使用當前填寫的值生成authorization header。所以在生成header之前要確保設置的正確性。如果當前的header已經存在,postman會移除之前的header。
OAuth 1.0a
postman的OAuth helper讓你簽署支持OAuth 1.0基於身份驗證的請求。OAuth不用獲取access token,你需要去API提供者獲取的。OAuth 1.0可以在header或者查詢參數中設置value。
OAuth 2.0
postman支持獲得OAuth 2.0 token並添加到requests中。
四 Writting Test
Postman的Tests標簽可以用來寫測試: 本質上是javascript code,可以為tests object設置values。這里使用描述性文字作為key,檢驗body中的各種情況,當然你可以創建任意多的key,這取決於你需要測試多少點。 tests也會隨着request保存到collection中。api測試保證前端后台都能正常的於api協作工作,而不用在出錯時猜測是哪里的問題。 需要在request的test中創建了test后,再進行request,test的結果在body的test中查看。 注意: 1.這里的key描述必須是唯一的,否則相同描述只會執行第一個。 2.這里的key可以使用中文。 例子:
tests[“Body contains user_id”] = responseBody.has(“user_id”)
這里描述性的key為:Body contains user_id。檢測點為:responseBody.has(“user_id”),意思是檢測返回的body中是否包含”user_id”這個字段。
查看responses中的Tests結果:記過顯示每個key,也就是我們測試點的具體結果,是否通過。
Testing Sandbox
postman的測試是運行在沙箱環境,是與app獨立的。查看什么在沙箱中是可用的,參見Sandbox documentation.
Snippets
用於快速添加常用的測試代碼。可以自定義snippets。
Viewing results
postman每次執行request的時候,會執行tests。測試結果會在tests的tab上面顯示一個通過的數量。
Testing Sandbox
Testing examples
測試代碼會在發送request並且接收到responses后執行。
1.設置環境變量 postman.setEnvironmentVariable("key", "value");
2.設置全局變量 postman.setGlobalVariable("key", "value");
3.檢查response body中是否包含某個string tests["Body matches string"] = responseBody.has("string_you_want_to_search");
4.檢測JSON中的某個值是否等於預期的值
var data = JSON.parse(responseBody); tests["Your test name"] = data.value === 100;
JSON.parse()方法,把json字符串轉化為對象。parse()會進行json格式的檢查是一個安全的函數。 如:檢查json中某個數組元素的個數(這里檢測programs的長度)
var data = JSON.parse(responseBody); tests["program's lenght"] = data.programs.length === 5;
5.轉換XML body為JSON對象 var jsonObject = xml2Json(responseBody);
6.檢查response body是否與某個string相等 tests["Body is correct"] = responseBody === "response_body_string";
7.測試response Headers中的某個元素是否存在(如:Content-Type)
tests["Content-Type is present"] = postman.getResponseHeader("Content-Type"); //getResponseHeader()方法會返回header的值,如果該值存在
或者:
tests["Content-Type is present"] = responseHeaders.hasOwnProperty("Content-Type");
上面的方法,不區分大小寫。下面的方法,要區分大小寫。
8.驗證Status code的值 tests["Status code is 200"] = responseCode.code === 200;
9.驗證Response time是否小於某個值 tests["Response time is less than 200ms"] = responseTime < 200;
10.name是否包含某個值 tests["Status code name has string"] = responseCode.name.has("Created");
11.POST 請求的狀態響應碼是否是某個值 tests["Successful POST request"] = responseCode.code === 201 || responseCode.code === 202;
12.很小的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);
結果:
五 運行Collections
postman允許你運行collection,你可以運行任意的次數。 最后會給出一個整體運行的結果。會保存每一次運行的結果,提供給你比較每一次運行解雇的不同。
選擇collection,選擇環境。點擊運行按鈕。 在需要csv和json文件的地方記得添加。
運行collection測試會在另一個窗口運行。如果需要在main窗口修改東西,在新窗口能正常讀取。