本節(jié)介紹phpStorm 中 HTTP 請求格式中使用變量的介紹。

編寫 HTTP 請求時，可以使用variables參數(shù)化其元素。變量可以保存請求的主機、端口和路徑的值、查詢參數(shù)或值、標(biāo)頭值或在請求正文或外部文件中使用的任意值。

在請求中提供一個變量

• 將變量括在雙花括號中作為{{variable}}.

變量名只能包含字母、數(shù)字、下劃線_或連字符-。變量的值可以是以下任何一種：

• 通過環(huán)境變量為每個環(huán)境顯式提供
• 通過$uuid、$timestamp和$randomInt預(yù)定義的動態(tài)變量動態(tài)生成
• 通過該方法在響應(yīng)處理程序腳本中以編程方式定義client.global.set。

環(huán)境變量

環(huán)境變量允許您在項目中存儲一組環(huán)境定義。例如，可以創(chuàng)建和使用{{host}}變量，而不是在請求中明確提供主機名。執(zhí)行請求時，可以在定義的環(huán)境之間進(jìn)行選擇，從而將其發(fā)送到特定主機：

在查看請求的結(jié)構(gòu)、在瀏覽器中打開請求、執(zhí)行請求并為其創(chuàng)建運行/調(diào)試配置時，所選環(huán)境將用作默認(rèn)環(huán)境。

定義環(huán)境變量

環(huán)境變量在環(huán)境文件中定義。

1. 在請求的編輯器面板頂部，在Run with列表中，選擇要添加環(huán)境的位置：
• 如果希望環(huán)境公開，請選擇將環(huán)境添加到公共文件...。這會將環(huán)境添加到http-client.env.json文件中。此文件可以包含常見變量，例如主機名、端口或查詢參數(shù)，并且旨在與您的項目一起分發(fā)。
• 如果希望環(huán)境是私有的，請選擇將環(huán)境添加到私有文件...。這會將環(huán)境添加到http-client.private.env.json文件中。此文件可能包含密碼、令牌、證書和其他敏感信息。默認(rèn)情況下，它會添加到 VCS 忽略文件列表中。http-client.private.env.json文件中指定的變量值會覆蓋公共環(huán)境文件中的值。
2. 使用所需的變量填充創(chuàng)建的文件。

   以下示例http-client.env.json環(huán)境文件定義了兩個環(huán)境：開發(fā)和生產(chǎn)。附加的http-client.private.env.json文件包含敏感的授權(quán)數(shù)據(jù)。

   http-client.env.json

      {
       "development": {
           "host": "localhost",
           "id-value": 12345,
           "username": "",
           "password": "",
           "my-var": "my-dev-value"
       },
   
       "production": {
           "host": "example.com",
           "id-value": 6789,
           "username": "",
           "password": "",
           "my-var": "my-prod-value"
       }
   }
   

   http-client.private.env.json

      {
       "development": {
           "username": "dev-user",
           "password": "dev-password"
       },
   
       "production": {
           "username": "user",
           "password": "password"
       }
   }
   

   示例 HTTP 請求如下：

      GET //{{host}}/api/json/get?id={{id-value}}
   Authorization: Basic {{username}} {{password}}
   Content-Type: application/json
   
   {
       "key": "{{my-var}}"
   }
   

   在執(zhí)行請求之前，PHP開發(fā)工具PhpStorm 允許您使用請求編輯器面板頂部的Run with列表來選擇執(zhí)行環(huán)境。

   根據(jù)用戶的選擇，生成的請求將是以下之一：

   發(fā)展

      GET //localhost/api/json/get?id=12345
   Authorization: Basic dev-user dev-password
   Content-Type: application/json
   
   {
       "key": "my-dev-value"
   }
   

   生產(chǎn)

     GET //example.com/api/json/get?id=6789
   Authorization: Basic user password
   Content-Type: application/json
   
   {
       "key": "my-prod-value"
   }
   

   如果在執(zhí)行請求時變量未解析，PhpStorm 會顯示一條通知，讓您快速創(chuàng)建、更新或選擇不同的執(zhí)行環(huán)境。

   

動態(tài)變量

每次運行請求時，動態(tài)變量都會生成一個值：

• $uuid：生成一個通用唯一標(biāo)識符（UUID-v4）
• $timestamp: 生成當(dāng)前的 UNIX 時間戳
• $randomInt: 生成 0 到 1000 之間的隨機整數(shù)。

例如：

  GET //localhost/api/get?id={{$uuid}}

處理響應(yīng)

可以使用 JavaScript 處理響應(yīng)。鍵入>請求后的字符并指定 JavaScript 文件的路徑和名稱或?qū)㈨憫?yīng)處理程序腳本代碼包裹在{% ... %}.

  GET //httpbin.org/get

> /path/to/responseHandler.js

   GET //httpbin.org/get

> {%
    client.global.set("my_cookie", response.headers.valuesOf("Set-Cookie")[0]);
%}

重定向響應(yīng)

可以將響應(yīng)重定向到文件。如果文件已存在，則用于>>;創(chuàng)建帶有后綴的新文件，如果文件存在>>!則重寫該文件。可以指定絕對路徑或相對于當(dāng)前 HTTP 請求文件的相對路徑。您還可以在路徑中使用變量，包括環(huán)境變量和以下預(yù)定義變量：

• {{$projectRoot}}指向項目根目錄：.idea
• {{$historyFolder}}指向.idea /httpRequests/

以下示例 HTTP 請求在 HTTP 請求文件旁邊的 myFolder 中創(chuàng)建 myFile.json 并將響應(yīng)重定向到它。如果文件已經(jīng)存在，它會創(chuàng)建myFile-1.json等等。

   POST //httpbin.org/post
Content-Type: application/json

{
  "id": 999,
  "value": "content"
}

>> myFolder/myFile.json

以下示例 HTTP 請求在.idea /httpRequests/中創(chuàng)建myFile.json。如果文件已經(jīng)存在，它會覆蓋該文件。它還使用位于項目根目錄中的handler.js腳本處理響應(yīng)。

  POST //httpbin.org/post
Content-Type: application/json

{
  "id": 999,
  "value": "content"
}

> {{$projectRoot}}/handler.js

>>! {{$historyFolder}}/myFile.json

以上就是HTTP請求語法中關(guān)于使用變量、處理文件、重定義響應(yīng)的相關(guān)內(nèi)容，下載phpstorm最新版本來確保自己功能達(dá)到最新。

phpstorm| 下載試用

phpstorm是一個輕量級且便捷的PHP IDE，其旨在提高用戶效率，可深刻理解用戶的編碼，提供智能代碼補全，快速導(dǎo)航以及即時錯誤檢查。可隨時幫助用戶對其編碼進(jìn)行調(diào)整，運行單元測試或者提供可視化debug功能。

JetBrain技術(shù)交流群現(xiàn)已開通，QQ搜索群號“786598704”，歡迎進(jìn)群討論。