postman 構(gòu)建請(qǐng)求

您可以在 Postman 中發(fā)送請(qǐng)求以連接到您正在使用的 API。您的請(qǐng)求可以檢索、添加、刪除和更新數(shù)據(jù)。無(wú)論您是構(gòu)建或測(cè)試自己的 API，還是與第三方 API 集成，您都可以在 Postman 中發(fā)送請(qǐng)求。您的請(qǐng)求可以發(fā)送參數(shù)、授權(quán)詳細(xì)信息和您需要的任何正文數(shù)據(jù)。

例如，如果您正在為商店構(gòu)建客戶端應(yīng)用程序（例如移動(dòng)或網(wǎng)絡(luò)應(yīng)用程序），您可能會(huì)發(fā)送一個(gè)請(qǐng)求來(lái)檢索可用產(chǎn)品列表，另一個(gè)請(qǐng)求來(lái)創(chuàng)建新訂單（包括所選產(chǎn)品的詳細(xì)信息） )，以及讓客戶登錄其帳戶的不同請(qǐng)求。

當(dāng)您發(fā)送請(qǐng)求時(shí)，Postman 會(huì)以一種允許您檢查、可視化并在必要時(shí)進(jìn)行故障排除的方式顯示從 API 服務(wù)器收到的響應(yīng)。

如果您以前從未發(fā)送過(guò)請(qǐng)求，請(qǐng)?jiān)诶^續(xù)之前檢查發(fā)送您的第一個(gè)請(qǐng)求。

創(chuàng)建請(qǐng)求

您的請(qǐng)求可以包含多個(gè)詳細(xì)信息，確定 Postman 將發(fā)送到您正在使用的 API 的數(shù)據(jù)。輸入一個(gè) URL 并選擇一種方法，然后可以選擇指定各種其他詳細(xì)信息。

您可以從 Postman 主屏幕創(chuàng)建新請(qǐng)求，方法是使用New > HTTP Request或選擇+打開新選項(xiàng)卡。

選擇保存以創(chuàng)建您的請(qǐng)求。您可以為您的請(qǐng)求命名和描述，然后選擇或創(chuàng)建一個(gè)集合來(lái)保存它。

打開新選項(xiàng)卡后，您可以指定請(qǐng)求所需的詳細(xì)信息。

添加請(qǐng)求詳細(xì)信息

如果您有要運(yùn)行的請(qǐng)求，則需要知道 URL、方法和其他可選值，例如身份驗(yàn)證和參數(shù)。

要測(cè)試在 Postman 中發(fā)送請(qǐng)求，您可以將 URL 設(shè)置為 Postman Echo 示例 API 端點(diǎn)https://postman-echo.com/get并將方法設(shè)置為GET，然后選擇Send。

設(shè)置請(qǐng)求 URL

您在 Postman 中發(fā)送的每個(gè)請(qǐng)求都需要一個(gè)表示您正在使用的 API 端點(diǎn)的 URL。您可以使用 API 執(zhí)行的每個(gè)操作通常都與一個(gè)端點(diǎn)相關(guān)聯(lián)。API 中的每個(gè)端點(diǎn)都可以在特定的 URL 上使用。這是您輸入 Postman 以訪問(wèn) API 的內(nèi)容。

• 如果您要構(gòu)建 API，URL 通常是基本位置加上路徑。例如，在請(qǐng)求中https://postman-echo.com/get，https://postman-echo.com是基本 URL，/get是端點(diǎn)路徑。
• 如果您使用的是第三方 API，您的 API 提供商將提供您需要的 URL，例如在他們的開發(fā)人員文檔中。

當(dāng)您開始在 URL 輸入字段中鍵入時(shí)，Postman 將顯示一個(gè)下拉列表，其中包含您可以用來(lái)自動(dòng)完成的以前使用過(guò)的位置。

http://如果您不指定協(xié)議，郵遞員將自動(dòng)添加到您的 URL 的開頭。

您可以選擇在 URL 字段中輸入查詢參數(shù)，也可以在“參數(shù)”選項(xiàng)卡中輸入它們。如果您的請(qǐng)求使用路徑參數(shù)，您可以將它們直接輸入到 URL 字段中。

您可以在請(qǐng)求中使用下一代 URL 編碼。

選擇請(qǐng)求方法

默認(rèn)情況下，Postman 將選擇GET新請(qǐng)求的方法。GET方法通常用于從 API 檢索數(shù)據(jù)。您可以使用多種其他方法將數(shù)據(jù)發(fā)送到您的 API，包括以下最常見(jiàn)的選項(xiàng)：

• POST— 添加新數(shù)據(jù)
• PUT— 替換現(xiàn)有數(shù)據(jù)
• PATCH— 更新一些現(xiàn)有的數(shù)據(jù)字段
• DELETE— 刪除現(xiàn)有數(shù)據(jù)

例如，如果您正在使用用于待辦事項(xiàng)列表應(yīng)用程序的 API，您可能會(huì)使用一種GET方法來(lái)檢索當(dāng)前任務(wù)列表、一種POST方法來(lái)創(chuàng)建新任務(wù)以及一種PUT或PATCH方法來(lái)編輯現(xiàn)有任務(wù)。

Postman 默認(rèn)支持一些額外的請(qǐng)求方法，你可以使用自定義方法。選擇方法下拉列表，編輯方法名稱文本，然后保存新方法。要?jiǎng)h除方法，請(qǐng)將鼠標(biāo)懸停在列表中的方法上方，然后選擇刪除圖標(biāo)  。

要測(cè)試https://postman-echo.com/get端點(diǎn)，請(qǐng)GET選擇方法并選擇發(fā)送。

通過(guò)接受不同的方法，同一位置（有時(shí)稱為“路線”）可以提供多個(gè)端點(diǎn)。例如，API 可能有一個(gè)POST /customer用于添加新客戶的端點(diǎn)和一個(gè)GET /customer用于檢索現(xiàn)有客戶的端點(diǎn)。

• 如果您的請(qǐng)求不需要參數(shù)或身份驗(yàn)證，您可以選擇發(fā)送以獲取響應(yīng)。
• 否則，指定您的參數(shù)和您需要發(fā)送到 API 的任何正文數(shù)據(jù)。
• 如果您不需要隨請(qǐng)求發(fā)送數(shù)據(jù)，請(qǐng)?jiān)O(shè)置任何必需的身份驗(yàn)證和標(biāo)頭。

發(fā)送參數(shù)

您可以使用 URL 字段和“參數(shù)”選項(xiàng)卡隨請(qǐng)求一起發(fā)送路徑和查詢參數(shù)。

• 查詢參數(shù)附加到請(qǐng)求 URL 的末尾，跟隨?并以鍵值對(duì)的形式列出，使用&以下語(yǔ)法分隔：?id=1&type=new
• 路徑參數(shù)構(gòu)成請(qǐng)求 URL 的一部分，并使用前面的占位符引用，:如以下示例所示：/customer/:id

要發(fā)送查詢參數(shù)，請(qǐng)將其直接添加到 URL 或打開Params并輸入名稱和值。當(dāng)您在 URL 或Params字段中輸入查詢參數(shù)時(shí)，這些值將在 Postman 中使用的任何地方更新。

參數(shù)不會(huì)自動(dòng)進(jìn)行 URL 編碼。右鍵單擊所選文本，然后選擇EncodeURIComponent以手動(dòng)編碼參數(shù)值。

要發(fā)送路徑參數(shù)，請(qǐng)?jiān)?URL 字段中輸入?yún)?shù)名稱，在冒號(hào)之后，例如:id。當(dāng)您輸入路徑參數(shù)時(shí)，Postman 會(huì)將其填充到“參數(shù)”選項(xiàng)卡中，您也可以在其中進(jìn)行編輯。

您可以為您的參數(shù)添加描述，它們將顯示給共享請(qǐng)求（例如在您的工作區(qū)中）或查看您的 API 文檔的任何人。

如果您更喜歡以純文本形式輸入?yún)?shù)而不是使用請(qǐng)求生成器，則可以使用批量編輯選項(xiàng)。

如果您的請(qǐng)求不需要正文數(shù)據(jù)、身份驗(yàn)證或標(biāo)頭，請(qǐng)選擇發(fā)送。否則，設(shè)置您的body、auth和headers。

發(fā)送正文數(shù)據(jù)

每當(dāng)您需要添加或更新結(jié)構(gòu)化數(shù)據(jù)時(shí)，您都需要隨請(qǐng)求發(fā)送正文數(shù)據(jù)。例如，如果您要發(fā)送將新客戶添加到數(shù)據(jù)庫(kù)的請(qǐng)求，您可能會(huì)在 JSON 中包含客戶詳細(xì)信息。通常，您會(huì)將正文數(shù)據(jù)與PUT、POST和PATCH請(qǐng)求一起使用。

Postman 中的Body選項(xiàng)卡允許您指定需要隨請(qǐng)求一起發(fā)送的數(shù)據(jù)。您可以發(fā)送各種不同類型的正文數(shù)據(jù)以適合您的 API。

如果您要發(fā)送正文數(shù)據(jù)，請(qǐng)確保選擇了正確的標(biāo)頭以指示您的 API 正確處理接收到的數(shù)據(jù)可能需要的內(nèi)容類型。對(duì)于表單數(shù)據(jù)和 urlencoded 主體類型，Postman 將自動(dòng)附加正確的Content-Type標(biāo)頭。如果您對(duì)正文數(shù)據(jù)使用原始模式，Postman 將根據(jù)您選擇的類型（例如文本或 json）設(shè)置標(biāo)題。如果您手動(dòng)選擇Content-Type標(biāo)頭，則該值將優(yōu)先于 Postman 設(shè)置的值。Postman 沒(méi)有為二進(jìn)制正文類型設(shè)置任何標(biāo)頭類型。

默認(rèn)情況下，Postman 將選擇“無(wú)”——如果您不需要隨請(qǐng)求發(fā)送正文，請(qǐng)將其選中。

選擇請(qǐng)求正文所需的數(shù)據(jù)類型——表單數(shù)據(jù)、URL 編碼、原始、二進(jìn)制或GraphQL。

表單數(shù)據(jù)

網(wǎng)站表單通常將數(shù)據(jù)作為multipart/form-data. form-data 您可以使用Body選項(xiàng)卡在 Postman 中復(fù)制它。表單數(shù)據(jù)允許您發(fā)送鍵值對(duì)，并指定內(nèi)容類型。

您可以使用表單數(shù)據(jù)附加文件。當(dāng)您重復(fù)發(fā)送相同文件的 API 調(diào)用時(shí)，Postman 將保留您的文件路徑以供以后使用。這也有助于您運(yùn)行包含需要文件上傳的請(qǐng)求的集合。不支持上傳多個(gè)文件，每個(gè)文件都有自己的內(nèi)容類型。

URL 編碼

URL 編碼數(shù)據(jù)使用與 URL 參數(shù)相同的編碼。如果您的 API 需要 url 編碼數(shù)據(jù)，請(qǐng)x-www-form-urlencoded在請(qǐng)求的正文選項(xiàng)卡中選擇。輸入您的鍵值對(duì)以隨請(qǐng)求一起發(fā)送，Postman 將在發(fā)送前對(duì)它們進(jìn)行編碼。

有時(shí)會(huì)混淆表單數(shù)據(jù)和 url 編碼。如果您不確定需要哪一個(gè)，請(qǐng)咨詢您的 API 提供商。

原始數(shù)據(jù)

您可以使用原始正文數(shù)據(jù)發(fā)送任何您可以輸入的文本。使用原始選項(xiàng)卡和類型下拉列表來(lái)指示您的數(shù)據(jù)格式（文本、JavaScript、JSON、HTML或XML），Postman 將啟用語(yǔ)法突出顯示并將相關(guān)標(biāo)頭附加到您的請(qǐng)求中。

如果您需要覆蓋郵遞員自動(dòng)發(fā)送的內(nèi)容類型標(biāo)頭，您可以手動(dòng)設(shè)置。

您可以在正文數(shù)據(jù)中使用變量，Postman 將在發(fā)送您的請(qǐng)求時(shí)填充它們的當(dāng)前值。

要美化您的 XML 或 JSON，請(qǐng)?jiān)诰庉嬈髦羞x擇文本，然后選擇?+Option+B或Ctrl+Alt+B。

二進(jìn)制數(shù)據(jù)

您可以使用二進(jìn)制數(shù)據(jù)來(lái)發(fā)送無(wú)法在 Postman 編輯器中使用請(qǐng)求正文手動(dòng)輸入的信息，例如圖像、音頻和視頻文件（您也可以發(fā)送文本文件）。

圖形QL

您可以通過(guò)選擇請(qǐng)求正文中的GraphQL選項(xiàng)卡，將 GraphQL 查詢與您的 Postman 請(qǐng)求一起發(fā)送。在查詢區(qū)域中輸入您的代碼，并在GraphQL 變量部分中輸入任何變量。

查看使用 GraphQL以獲取有關(guān) GraphQL 的更多信息，包括如何啟用由 Postman API 模式提供支持的自動(dòng)完成功能。

驗(yàn)證請(qǐng)求

某些 API 需要您可以在 Postman 中發(fā)送的身份驗(yàn)證詳細(xì)信息。認(rèn)證涉及確認(rèn)發(fā)送請(qǐng)求的客戶端的身份，授權(quán)涉及確認(rèn)客戶端具有執(zhí)行端點(diǎn)操作的權(quán)限。打開授權(quán)選項(xiàng)卡以配置您的訪問(wèn)詳細(xì)信息。

Postman 會(huì)自動(dòng)將您的身份驗(yàn)證詳細(xì)信息包含在請(qǐng)求的相關(guān)部分中，例如在Headers中。

有關(guān)在 Postman 請(qǐng)求中實(shí)現(xiàn)不同類型身份驗(yàn)證的更多詳細(xì)信息，請(qǐng)查看授權(quán)請(qǐng)求。

設(shè)置您的身份驗(yàn)證和其他請(qǐng)求詳細(xì)信息后，選擇發(fā)送以運(yùn)行您的請(qǐng)求。

配置請(qǐng)求標(biāo)頭

某些 API 要求您隨請(qǐng)求一起發(fā)送特定標(biāo)頭，通常是為了提供有關(guān)您正在執(zhí)行的操作的更多元數(shù)據(jù)。您可以在標(biāo)題選項(xiàng)卡中設(shè)置這些。輸入您需要的任何鍵值對(duì)，Postman 會(huì)將它們與您的請(qǐng)求一起發(fā)送。當(dāng)您輸入文本時(shí)，Postman 會(huì)提示您使用可用于自動(dòng)完成設(shè)置的常用選項(xiàng)，例如Content-Type.

您可以將常用的標(biāo)題一起保存在標(biāo)題預(yù)設(shè)中。在Headers選項(xiàng)卡中，選擇Presets，然后選擇Manage Presets。通過(guò)提供名稱并輸入鍵加值來(lái)添加每個(gè)預(yù)設(shè)。選擇添加，您的預(yù)設(shè)將出現(xiàn)在預(yù)設(shè)下拉列表中。選擇預(yù)設(shè)將自動(dòng)填充請(qǐng)求標(biāo)頭中的字段。

自動(dòng)生成的標(biāo)題

Postman 會(huì)根據(jù)您的請(qǐng)求選擇和設(shè)置自動(dòng)將某些標(biāo)頭添加到您的請(qǐng)求中。選擇標(biāo)題選項(xiàng)卡頂部的隱藏，以獲取有關(guān) Postman 將隨您的請(qǐng)求發(fā)送的內(nèi)容的信息。

將鼠標(biāo)懸停在標(biāo)題上以獲取有關(guān)它的詳細(xì)信息。郵遞員將指出添加標(biāo)頭的原因。如果需要，詳細(xì)信息將指示如何停用或覆蓋標(biāo)頭值。

停用或覆蓋推薦的標(biāo)頭可能會(huì)使您的請(qǐng)求出現(xiàn)意外行為。

如果您需要更改標(biāo)題，您可以在 Postman 的相關(guān)部分進(jìn)行更改，例如Authorization選項(xiàng)卡、請(qǐng)求Body、請(qǐng)求域的Cookies 、 Settings，在某些情況下直接在Headers選項(xiàng)卡本身中進(jìn)行。

如果您需要轉(zhuǎn)到應(yīng)用程序的不同部分，Postman 會(huì)在右側(cè)顯示一個(gè)鏈接。

如果已根據(jù)您的身份驗(yàn)證設(shè)置添加標(biāo)頭，請(qǐng)選擇“授權(quán)”選項(xiàng)卡進(jìn)行更改。

要更改 cookie 標(biāo)頭，請(qǐng)更改您要向其發(fā)送請(qǐng)求的域的cookie 設(shè)置。

要直接在Headers中停用自動(dòng)生成的標(biāo)頭，請(qǐng)清除其復(fù)選框。要覆蓋自動(dòng)生成的標(biāo)頭值，請(qǐng)取消選中自動(dòng)生成的條目并為標(biāo)頭添加一個(gè)單獨(dú)的條目，在Key字段中列出其名稱并在Value字段中指定您的值。

如果同一個(gè)標(biāo)頭有多個(gè)條目，Postman 將指示將覆蓋哪一個(gè)，優(yōu)先考慮您直接在標(biāo)頭中明確添加的標(biāo)頭，或者通過(guò)您在請(qǐng)求的其他部分（例如Authorization ）中所做的選擇間接添加的標(biāo)頭。

對(duì)于Content-Length和Content-Typeheaders，Postman 將在您發(fā)送請(qǐng)求時(shí)根據(jù)Body選項(xiàng)卡中的數(shù)據(jù)自動(dòng)計(jì)算值。但是，您可以覆蓋這兩個(gè)值。

設(shè)置標(biāo)頭和其他請(qǐng)求詳細(xì)信息后，您可以選擇“發(fā)送”以運(yùn)行您的請(qǐng)求。

使用 cookie

您可以從 Postman 為您的域管理 Cookie。選擇Cookie（在發(fā)送下）。有關(guān)詳細(xì)信息，請(qǐng)參閱管理 cookie。

選擇自定義設(shè)置

您可以使用請(qǐng)求設(shè)置選項(xiàng)卡為 Postman 請(qǐng)求配置各種設(shè)置。這些允許您將非標(biāo)準(zhǔn)邏輯應(yīng)用于您的請(qǐng)求。

編碼您的請(qǐng)求 URL

Postman 解析并編碼您的請(qǐng)求 URL，以最大限度地提高 API 調(diào)用的成功率。Postman 對(duì)您的 URL 中的字符進(jìn)行編碼，并將它們映射到您的 API 最有可能接受的表示形式。Postman URL 處理器優(yōu)化了您的請(qǐng)求被廣泛使用的服務(wù)器實(shí)現(xiàn)有效處理的機(jī)會(huì)。

處理器將根據(jù)字符在 URL 中出現(xiàn)的位置對(duì)字符進(jìn)行編碼：

處理器在 Postman 中默認(rèn)打開，但如果您使用的是不尋常的服務(wù)器實(shí)現(xiàn)，則可以關(guān)閉編碼。要在您的請(qǐng)求中打開或關(guān)閉此設(shè)置，請(qǐng)選擇“設(shè)置”>“自動(dòng)編碼 URL”。

您可以通過(guò)突出顯示文本并單擊鼠標(biāo)右鍵，然后選擇EncodeURIComponent來(lái)選擇性地對(duì) URL 的某些部分進(jìn)行編碼。

對(duì)您的請(qǐng)求進(jìn)行故障排除

Postman 將指出您請(qǐng)求中可能無(wú)法按預(yù)期運(yùn)行的部分中的任何空格或無(wú)效字符，以便您可以糾正您的值。請(qǐng)求方法、URL（包括路徑）、參數(shù)、標(biāo)頭（包括您的密鑰名稱）和正文中會(huì)突出顯示無(wú)效字符。

如果 Postman 無(wú)法發(fā)送您的請(qǐng)求或沒(méi)有收到回復(fù)，您將收到一條消息，其中包含有關(guān)錯(cuò)誤的詳細(xì)信息。選擇在控制臺(tái)中查看以了解您的請(qǐng)求的概覽并幫助確定問(wèn)題的根源。

如果您的請(qǐng)求沒(méi)有按預(yù)期工作，請(qǐng)查看一些故障排除提示。

下一步

設(shè)置請(qǐng)求后，選擇發(fā)送并檢查響應(yīng)。