簡介

postman是谷歌推出的一款模擬API網絡請求的工具,不僅方便接口的調試,而且加快前后端開發人員溝通交流.

優點

• 可以配置多個API請求環境,快速切換到不同環境進行數據請求
• 可以設置全局宏定義
• 可以設置環境變量宏定義
• 可以通過腳本對請求前后的數據進行校驗
• 可以對請求進行歸類集合,形成API文檔(付費用戶可以進行云端數據同步)
• 可以對每個參數添加描述,注釋支持markdown語法描述

安裝

postman官網首頁

主界面功能介紹

postman主界面

主界面按照功能大致可以劃分為五個模塊:

1. 側邊欄

側邊欄主要有三個功能:

1. filter:主要是對History和Collections的檢索功能
2. History:每次進行請求的歷史記錄
3. Collections:對請求進行歸類集合,可以構建多級目錄

如圖所示:Collections可以對請求進行歸類并保存,可以作為API文檔進行查看,方便前后端開發人員進行溝通.

2. API請求環境配置

功能點描述

1. 請求的標簽欄,一個標簽代表一個請求

2. 本次請求的環境選擇,點擊右邊箭頭可以進行不同環境的選擇

   
   
   環境切換
3. 點擊可以查看當前請求環境和全局環境的宏定義.
   
   環境變量的宏定義查看
   
   點擊Edit可以對環境變量的宏定義進行增加和修改
   
   環境變量宏定義編輯界面
4. 點擊Manage Environment可以配置環境變量
   
   Manage Environment
   
   
   編輯請求環境

3. API請求構建及參數說明

請求構建

1. 接口描述:在此注明此接口的使用方法,參數說明,已經注意事項等信息,支持markdown語法
2. 接口返回結果:如果有Examples()*括號中有值,代表此接口有返回結果的 示例(結果保存方式在下面介紹)
3. 接口的請求方式:可以根據需要選擇對應的請求方式,支持類型還是很多的
4. 接口的URL及Params:一般每個環境的URL是不變的,可以在環境變量中設置成宏定義,調用方式為{{api_url}}(兩個大括號就能調出 并帶有檢索提示功能);比如設置的api_url在不同環境可以設置為不同的值,但是對應的key(api_url)是一樣的.

5. 參數的按鈕:選擇顯示或者隱藏請求體中攜帶的參數
6. 發送請求:對本次構建的請求進行模擬,右邊按鈕可以選擇發送請求并下載請求的結果
7. 保存本次請求:對本次構建的請求進行歸類整理,保存到側邊欄的Collections,付費用戶可以對數據進行云端同步
8. 參數的設置URL后面拼接的參數,例如截圖中的access_token(本示例為post請求,參數應放在body中,在此只是為了說明需要),比如get請求體中如果帶有參數,點擊params會自動識別并顯示參數的key和value;參數前面的選中按鈕,可以控制本次請求是否帶有此參數;在顯示的參數后面有discripttion可以填寫對此參數的描述;

4. API請求的二次構建和腳本處理

這部分主要是對請求的二次構建,主要有一下幾個功能:

1. Authorization:設置鑒權參數，可以用OAuth之類的
   

   鑒權方式

2. Headers:自定義HTTP Header,定義后臺返回的數據格式,比如json/xml
   

   json數據格式定制

3. Body:post請求方式的參數,有四種形式可以選擇，form-data主要用于上傳文件。x-www-form-urlencoded是表單常用的格式。raw可以用來上傳JSON數據
   

   參數示例

4. Pre-request Script:在發起請求之前執行的腳本，比如參數中需要攜帶的時間戳,隨機數等

5. Tests:在收到response之后執行的測試，比如對response的請求狀態驗證,對數據格式的校驗等

//驗證請求的狀態碼
tests["code is correct"] = responseCode.code === 200; 
//json數據解析
var data = JSON.parse(responseBody);    
//獲取返回數據中的token并設置為環境變量              
postman.setEnvironmentVariable("access_token", data.data.access.token); 
//獲取返回數據中的user_id并設置為環境變量
postman.setEnvironmentVariable("user_id", data.data.user.user_id);

5. API請求結果查看

這部分主要是對請求結果的查看,主要有一下幾個功能(對應第四部分的相應功能):

1. body:返回數據的格式，Pretty可以看到格式化后的數據(有json/xml等多個選擇)，Raw就是未經處理的數據，Preview可以預覽HTML頁面
   

   格式化返回數據

2. Cookies:返回的結果中是否有Cookies

3. Headers:后端返回數據的格式
   

4. Tests:第四部分中的Tests腳本執行結果
   

   腳本正確執行

關于利用postman進行測試,或者數據校驗后期補充,主要用到的是javascript語法