一 簡介
特色:前端
- 建立 + 測試:建立和發送任何的HTTP請求,請求能夠保存到歷史中再次執行
- Organize:使用Postman Collections爲更有效的測試及集成工做流管理和組織APIs
- document:依據你建立的Clollections自動生成API文檔,並將其發佈成規範的格式
- collarorate:經過同步鏈接你的team和你的api,以及權限控制,API庫
二 請求
postman界面分爲兩部分:左邊的sidebar 右邊的request builder:快速建立幾乎全部的請求 java
HTTP請求的4部分:URL,請求的method,headers,body。 spring
URL
首先須要設置的就是URL json
注意:若是在輸入參數時,沒有自動decode到URL中,則能夠選中參數右鍵後,選擇EncodeURIComponent(通常都會自動填充的): api
一樣也能夠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窗口修改東西,在新窗口能正常讀取。