簡單的 Postman，還能玩出花？

Postman 是一款我們在工作中使用頻率非常高的 API 調試工具，估計很多童鞋在使用它時也比較粗暴，填好接口地址、參數，直接 send 就完事了，估計大家要說了，這麼簡單的東西還能玩出什麼花來。今天就和大家安利幾個非常實用、但是可能一直被忽視的功能，用完之後，簡直不要太香！

環境變量

我們通過一個例子來看一下環境變量的用法，在一個項目的生命週期中，可能會有開發環境、測試環境、預上線環境、線上環境等衆多的不同環境，這時候就可以通過環境變量來管理接口的地址以及端口。

點擊左側的Environments，系統中默認已經存在了一個Globals的全局環境，在這裏可以存放一些通用的公共變量的值。先在這裏寫入host和port信息：

在需要使用變量時，可以在訪問接口時使用雙大括號包裹變量，以{{variable}}的方式進行引用：

除了默認的全局環境外，也可以自己創建新的環境來存放變量。在下面的例子中，創建了local和test兩個環境，這樣我們可以直接在兩個環境間進行切換激活，簡化了開發中測試接口的過程，不再需要頻繁的改動接口的地址。

如果激活的環境和全局環境中有名稱重複的變量，那麼當前激活的環境中的變量具有更高的優先級，它會直接覆蓋globals環境中變量的值：

在上面，我們將環境變量分爲了兩類，普通環境變量和全局變量。總的來說，全局變量具有更高的使用範圍，即使切換到自己創建的環境，全局變量仍然可用。但是我們自己創建的環境之間是相互隔離的，如果切換到一個環境，那麼其他環境中的變量將不再可用。

像上面這樣手動寫入變量的值，在某些時候可能不太方便滿足一些需求，因此 postman 提供了一種方法，允許使用腳本來改變環境變量的值。我們來看一下發送請求中的Pre-request Script和Tests模塊，它們是在請求發送前或完成後執行的腳本，具體的使用在後面具體介紹，現在我們只需要知道能在這裏執行 js 代碼就可以了。

下面，在Pre-request Script中加入兩行 js 代碼：

pm.globals.set("key1","value1");
pm.environment.set("key2","value2");

執行完成請求後再次查看環境變量，全局環境和當前環境中都寫入了新的值：

同樣，也可以使用腳本刪除變量：

pm.globals.unset("key1");
pm.environment.unset("key2");

除了上面的兩類變量外，postman 中的Collection也可以存儲變量。Collection可以理解爲一個集合，通常在使用中我們會將一個應用系統中的接口放在一個集合中，集合中的變量擁有更小的使用範圍，僅在當前集合內可用：

同樣，也可以在腳本中對它進行操作：

pm.collectionVariables.set("key3","value3");
pm.collectionVariables.unset("key3");

在有了環境變量的基礎後，再回頭看一下上面提到的Pre-request Script和Tests，它們是兩個比較類似的功能，用處也非常廣泛。

Pre-request Script

運行 js 腳本

Pre-request Script可以翻譯爲預請求腳本，是在請求發送前被執行的代碼邏輯，可以在這裏執行一些js代碼。通過下面的簡單例子進行一下演示，先準備一個後臺接口，將前端傳遞過來的時間戳轉換爲時間並打印：

 @GetMapping("test1")
 public void time(@RequestParam("time") String time){
     Date date = new Date(Long.parseLong(time));
     System.out.println(date);
 }

在Pre-request Script中利用 js 代碼獲取當前時間，並放到集合變量中，在請求中傳給後端：

發送請求，控制檯打印了前端接口的調用時間：

Tue Aug 01 14:14:29 CST 2021

發送 get 請求

Pre-request Script的另一大用途就是，在請求當前接口前，通過執行腳本來先請求一下其他接口。在 postman 中，已經內置了sendRequest方法來發送get方法請求。我們在這裏調用一個本地接口，並將信息打印到console控制檯（可以通過 Show Postman Console開啓）。

通過控制檯的打印順序，也可以看到，是在先執行了Pre-request中的請求後，纔去執行的真正目標接口的請求。直接像上面這樣調用sendRequest時，默認發送的get的請求，如果需要使用post請求、配置請求header或使用json傳參的話，可以使用下面單獨封裝請求的方式。

發送 post 請求

在這裏，我們通過一個例子來演示Pre-request Script在具體的工作中能夠怎樣應用。有一個很普遍的場景，通常在調試需要權限認證的接口時，需要提前通過一個接口獲取 token，然後再訪問目標接口時攜帶這個 token。

這時就可以在Pre-request Script中先調用獲取 token 的接口，再將 token 設置到集合的環境變量中，在之後的接口調用中引用它。在這裏先準備了一個應用了Shiro+JWT的項目，其中通過登錄接口獲取 token，之後的其他接口都需要帶上這個 token 用於認證 。

我們在sendRequest發送get請求的基礎上，進行一些修改。首先定義一個變量，在其中使用url指定請求地址，method指定請求方法，body攜帶參數，最後使用sendRequest進行請求的發送。

在獲取完成 token 後，通過下面的代碼將獲取的 token 放入了Collection的變量中：

pm.collectionVariables.set("TOKEN",response.json().data.token);

查看Collection中的變量，已經保存了剛纔獲取的 token：

在需要認證的接口header中，引用這個 token，就可以正常的調用接口了：

在上面的例子中，我們使用的是urlencoded的表單傳參方式，如果接口定義是使用 json 方式傳參，可以寫成下面的格式：

body: {
  mode: 'raw',
  raw: JSON.stringify({ key: 'value' })
}

如果需要傳遞header請求頭信息，也可以在自定義的請求中添加：

const loginRequest = {
  url: '...',
  header: [
      'Key1 : Value1',
      'Key2 : Value2'
  ],
  ...
};

具體的使用中需要添加什麼字段非常的靈活，可以由我們自行進行配置。

Tests

和Pre-request Script相對，Tests是在請求完成後執行的操作。這裏我們回顧一下上面Pre-request Script中發送post請求的例子，其實可以通過Tests來進行改進。

因爲在上面的例子中，獲取到的 token 是JWT生成的，具有一定有效時間，在一段時間內是都可以複用的。因此我們可以先手動調用一次login接口獲取 token，完成後在Tests中使用腳本將獲取的 token 放入Collection的變量中，就不需要在每次調用接口前都調用login接口重複獲取 token 了。

調用login接口並存入緩存的過程：

之後在調用其他需要攜帶這個 token 的接口時，使用{{TOKEN}}的方式，就會自動填充剛纔保存的TOKEN值。這樣在獲取到新的 token 後，每個接口中的 token 都會自動更新，就不需要再手動複製到每個接口了，極大的減少了工作量。

在 postman 中，在Collection中可以創建Folder文件夾，並且集合和文件夾上也可以添加Pre-request Script和Tests腳本。我們來看一下位於Folder中的請求，在執行Pre-request Script和Tests時順序是怎樣的，在每個環節中加入對應的打印語句，最後輸出的結果是這樣的：

也就是說，在發送請求前，postman 會先執行所有Pre-request Script，並且順序是集合最先、文件夾次之、最後是請求中的，在執行完成真正的請求後執行所有的Tests，順序同上。這也就要求我們在使用Pre-request Script及Tests功能前，首先要求我們對接口的調用順序、數據的流向有一個明確的瞭解，這樣才能保證不會出現取不到值或更新錯誤的情況。

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/DyOYcttvEHULSZGxCP9lAA

猜你喜歡