碼上快樂

相關內容    簡體    繁體

postman的使用方法詳解

本文轉載自   查看原文   2017-08-08 23:49   33207    postman/ 開發工具/ 教程

  1. Collections：在Postman中，Collection類似文件夾，可以把同一個項目的請求放在一個Collection里方便管理和分享，Collection里面也可以再建文件夾。如果做API文檔的話，可以每個API對應一條請求，如果要把各種輸入都測到的話，就需要每條測試一條請求了。這里我新建了一個example用於介紹整個流程，五個API對應五條請求。這個Collection可以通過https://www.getpostman.com/collections/96b64a7c604072e1e4ee 導入你自己的Postman中。

  2. 上面的黑字注冊是請求的名字，如果有Request description的話會顯示在這下面。下面的藍字是保存起來的請求結果，點擊可以載入某次請求的參數和返回值。我會用這個功能給做客戶端的同事展示不同情況下的各種返回值。保存請求的按鈕在15.

  3. 選擇HTTP Method的地方，各種常見的不常見的非常全。

  4. 請求URL，兩層大括號表示這是一個環境變量，可以在16的位置選擇當前的environment，環境變量就會被替換成該environment里variable的值。

  5. 點擊可以設置URL參數的key和value

  6. 點擊發送請求

  7. 點擊保存請求到Collection，如果要另存為的話，可以點擊右邊的下箭頭

  8. 設置鑒權參數，可以用OAuth之類的

  9. 自定義HTTP Header，有些因為Chrome願意不能自定義的需要另外裝一個插件Interceptor，在16上面一行的衛星那里

  10. 設置Request body，13那里顯示的就是body的內容

  11. 在發起請求之前執行的腳本，例如request body里的那兩個random變量，就是每次請求之前臨時生成的。

  12. 在收到response之后執行的測試，測試的結果會顯示在17的位置

  13. 有四種形式可以選擇，form-data主要用於上傳文件。x-www-form-urlencoded是表單常用的格式。raw可以用來上傳JSON數據

  14. 返回數據的格式，Pretty可以看到格式化后的JSON，Raw就是未經處理的數據，Preview可以預覽HTML頁面

  15. 點擊這里把請求保存到2的位置

  16. 設置environment variables和global variables，點擊右邊的x可以快速查看當前的變量。

  17. 測試執行的結果，一共幾個測試，通過幾個。

這個界面就是免費版的主要內容，和其他API測試工具相比，已經足夠好用。如果要使用自動化測試，需要購買9.99美金的Jetpacks，暫時不想購買的話可以試一下 Team版Postman 。現在是可以免費試用的，不但擁有Jetpacks的功能，還能與其他賬戶同步Collection。

　　Postman 是一個很強大的 API調試、Http請求的工具，當你還准備拿着記事本傻傻的去寫 Form 表單的時候，你來試試 Postman，你會震驚到的。

　　首先打開，顯示的主界面如下：

　　 

　　下面簡單介紹一下你可能會使用到的幾個按鈕操作。

　　

  • 導入：用於導入你或團隊保存的API請求文件，json格式。
  • 新建文件夾：用於API請求划分類別，便於管理。
  • 保存請求：保存你的API請求，返回值也能存儲下來。
  • 下載：下載你測試通過的API請求，團隊共享，導入。json格式，可手動編輯的。

　　她允許用戶發送任何類型的 HTTP 請求，例如 GET，POST，HEAD，PUT、DELETE等，並且可以允許任意的參數和 Headers。
　　她支持不同的認證機制，包括 Basic Auth，Digest Auth，OAuth 1.0，OAuth 2.0等。
　　她還可以響應數據是自動按照語法格式高亮的，包括 HTML，JSON和XML。

特點：

  1. 創建 + 測試：創建和發送任何的HTTP請求，請求可以保存到歷史中再次執行
  2. Organize:使用Postman Collections為更有效的測試及集成工作流管理和組織APIs
  3. document:依據你創建的Clollections自動生成API文檔,並將其發布成規范的格式
  4. 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提交(如上傳文件)。但該文件不會作為歷史保存，只能在每次需要發送請求的時候，重新添加文件。 

　　

urlencoded

　　同前面一樣，注意,你不能上傳文件通過這個編碼模式。

　　該模式和表單模式會容易混淆。urlencoded中的key-value會寫入URL，form-data模式的key-value不明顯寫入URL，而是直接提交。

raw

　　raw request可以包含任何東西。所有填寫的text都會隨着請求發送。　

　　

binary

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

二、響應

　　保證API響應的正確性，就是你需要做的大部分工作。postman的response viewer部分會協助你完成該工作且使其變得簡單。

　　一個API的響應包含body,headers,響應狀態碼。postman將body和headers放在不同的tabs中。響應碼和響應時間顯示在tabs的旁邊。將鼠標懸停在響應碼上面可以查看更詳細的信息。

保存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說明。

身份驗證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，選擇環境。點擊運行按鈕。 

　　

json文件的地方記得添加。

運行collection測試會在另一個窗口運行。如果需要在main窗口修改東西，在新窗口能正常讀取。

 

一、基本功能

Postman的功能在 文檔 中有介紹。不過文檔略啰嗦，這里簡單介紹一下主界面，入門功能就都提到了。

  1. Collections：在Postman中，Collection類似文件夾，可以把同一個項目的請求放在一個Collection里方便管理和分享，Collection里面也可以再建文件夾。如果做API文檔的話，可以每個API對應一條請求，如果要把各種輸入都測到的話，就需要每條測試一條請求了。這里我新建了一個example用於介紹整個流程，五個API對應五條請求。這個Collection可以通過https://www.getpostman.com/collections/96b64a7c604072e1e4ee 導入你自己的Postman中。

  2. 上面的黑字注冊是請求的名字，如果有Request description的話會顯示在這下面。下面的藍字是保存起來的請求結果，點擊可以載入某次請求的參數和返回值。我會用這個功能給做客戶端的同事展示不同情況下的各種返回值。保存請求的按鈕在15.

  3. 選擇HTTP Method的地方，各種常見的不常見的非常全。

  4. 請求URL，兩層大括號表示這是一個環境變量，可以在16的位置選擇當前的environment，環境變量就會被替換成該environment里variable的值。

  5. 點擊可以設置URL參數的key和value

  6. 點擊發送請求

  7. 點擊保存請求到Collection，如果要另存為的話，可以點擊右邊的下箭頭

  8. 設置鑒權參數，可以用OAuth之類的

  9. 自定義HTTP Header，有些因為Chrome願意不能自定義的需要另外裝一個插件Interceptor，在16上面一行的衛星那里

  10. 設置Request body，13那里顯示的就是body的內容

  11. 在發起請求之前執行的腳本，例如request body里的那兩個random變量，就是每次請求之前臨時生成的。

  12. 在收到response之后執行的測試，測試的結果會顯示在17的位置

  13. 有四種形式可以選擇，form-data主要用於上傳文件。x-www-form-urlencoded是表單常用的格式。raw可以用來上傳JSON數據

  14. 返回數據的格式，Pretty可以看到格式化后的JSON，Raw就是未經處理的數據，Preview可以預覽HTML頁面

  15. 點擊這里把請求保存到2的位置

  16. 設置environment variables和global variables，點擊右邊的x可以快速查看當前的變量。

  17. 測試執行的結果，一共幾個測試，通過幾個。

這個界面就是免費版的主要內容，和其他API測試工具相比，已經足夠好用。如果要使用自動化測試，需要購買9.99美金的Jetpacks，暫時不想購買的話可以試一下 Team版Postman 。現在是可以免費試用的，不但擁有Jetpacks的功能，還能與其他賬戶同步Collection。

二、測試工具

測試工具主要包括三部分，在發起請求之前運行的Pre-request，在收到應答之后運行的Test，和一次運行所有請求的Collection Runner

1. Pre-request

Pre-request的編寫界面如下：

Pre-request和Test用的語言都是JavaScript，Postman在一個沙盒里執行代碼，提供給用戶的庫和函數可以在 這里 查看。而 常用的功能都可以通過右邊的Code Snippets實現，點擊就可以插入到代碼區域 。

可以看到Pre-request里常用的功能就兩種，設置環境變量和設置全局變量。這條請求的pre-request就是在注冊之前生成一個字符串作為隨機用戶名。

postman.setEnvironmentVariable("random_username", ("0000" + (Math.random()*Math.pow(36,4) << 0).toString(36)).slice(-4));

其他用法還包括在發起請求之前獲取當前的時間戳放在參數里：

postman.setEnvironmentVariable("unixtime_now", Math.round(new Date().getTime()/1000));

當然也可以用來生成校驗串。總之，在發請求之前需要手動修改的東西，都可以考慮用腳本自動實現。

2. Test

Test的編寫界面如下：

和Pre-request相比，Test的Snippets就豐富多了，例如檢查狀態碼、檢查響應串、驗證JSON、檢查header、限制應答時間。

如果需要將服務器響應的數據保存下來，用在后面的請求里，也需要在這一步做。

在圖中的Test里，我首先檢查了狀態碼為200，然后解析返回的JSON，把環境變量里的token設為JSON里的token。

3. Collection Runner

當編寫了很多測試之后，就可以使用Collection Runner來自動運行整個Collection了，入口就在主界面最上面一行的 Runner 。選好Collection、Environment，如果有需要還可以載入JSON和CSV作為數據源。點擊 Start Test Run ，就可以看到結果了。

這里可以看到一共發起了5次請求，每個請求各有一個Test，全部Pass。（雖然最后一個請求的返回是403，但是這個請求的期望返回值就是403，所以也是Pass的）


免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。



猜您在找 postman的使用方法詳解 接口調試之Postman 使用方法詳解 postman的安裝和使用方法詳解 postman的使用方法詳解！最全面的教程 postman的使用方法詳解！最全面的教程 Postman如何安裝以及使用方法 EVO使用方法詳解 tmux使用方法詳解 FormData使用方法詳解 FormData使用方法詳解
 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM