Postman 指定示例

示例顯示了您的 API 端點的運行情況，并提供了有關(guān)請求和響應(yīng)如何工作的更多詳細信息。您可以通過保存響應(yīng)向請求添加示例，也可以創(chuàng)建帶有自定義響應(yīng)的示例來說明特定用例。創(chuàng)建示例后，您可以使用它們來設(shè)置模擬服務(wù)器或向 API 文檔添加更多詳細信息。

理解示例

在 Postman 中，一個例子是由請求和相關(guān)響應(yīng)組成的配對。每個示例都包含請求部分（方法、URL、參數(shù)、標頭和正文）和響應(yīng)部分（狀態(tài)代碼、正文和標頭）。您可以通過將示例添加到集合中的請求來創(chuàng)建示例，一個請求可以有多個示例。

為一個請求提供多個示例有助于說明端點響應(yīng)請求的不同方式。您可能有使用不同狀態(tài)代碼（例如 200 或 404）響應(yīng)或返回不同數(shù)據(jù)（或根本沒有數(shù)據(jù)）的示例。

示例有多種用途。開發(fā)人員和測試人員可以參考示例來更好地了解端點在不同場景中的功能。示例也可用于設(shè)置模擬服務(wù)器，這樣開發(fā)人員和測試人員就可以開始針對您的 API編寫代碼——甚至在它完成之前。此外，您可以在 API 的公共文檔中包含示例，以幫助世界上使用您的 API 的任何人。

添加示例

一個示例總是與集合中的一個請求相關(guān)聯(lián)，并且一個請求可以有多個示例。要向請求添加示例，請發(fā)送請求，然后將響應(yīng)保存為示例。您還可以手動向請求添加示例并定義自定義響應(yīng)。使用任一方法添加示例后，您可以隨時對其進行編輯以進行更改。

為獲得最佳 Postman 性能，示例響應(yīng)必須小于 5 MB。

保存響應(yīng)作為示例

在 Postman 中保存回復(fù)時，您可以選擇將其保存為示例。

1. 在邊欄中選擇收藏集。
2. 打開請求并選擇發(fā)送。
3. 在響應(yīng)窗格中，選擇保存響應(yīng)，然后選擇另存為示例。

您不能向 WebSocket 請求添加示例。對于 WebSocket 請求，您可以將消息與請求一起保存。

對于帶有流方法的gRPC 示例，您必須在將響應(yīng)/消息流保存為示例之前結(jié)束流。

添加自定義示例

通過自定義示例，您可以定義請求和響應(yīng)的外觀，包括狀態(tài)代碼和響應(yīng)正文。

1. 在邊欄中選擇收藏集。
2.  選擇請求旁邊的更多操作圖標 ，然后選擇添加示例。
3. 輸入示例的名稱。
4. 編輯示例的請求部分。根據(jù)需要添加任何參數(shù)或標頭。輸入請求正文并選擇內(nèi)容類型。
5. 編輯示例的響應(yīng)部分。輸入狀態(tài)代碼（例如 200 或 404）。輸入響應(yīng)正文并選擇內(nèi)容類型。根據(jù)需要添加任何標頭。
6. 選擇保存以保存示例。

嘗試一個例子

示例與其關(guān)聯(lián)的請求一起存儲在一個集合中。您可以通過在新選項卡中將示例作為請求打開來嘗試示例。

1. 在邊欄中選擇收藏集。
2. 選擇一個請求，然后選擇一個示例將其打開。
3. 選擇嘗試在新選項卡中將示例作為請求打開。該請求將自動發(fā)送到新選項卡中。
4. 查看請求和響應(yīng)詳細信息。新請求不會自動保存。您正在嘗試的示例的名稱位于工作臺中請求名稱的旁邊。選擇示例的名稱以在單獨的選項卡中將其打開。
5. 或者，您可以選擇保存以將新請求保存到工作區(qū)中的新集合或現(xiàn)有集合。
6. 選擇保存新請求的位置，然后選擇保存。

編輯示例

您可以隨時編輯示例以刪除敏感標記、更改狀態(tài)代碼或進行任何其他調(diào)整。

要編輯示例，請執(zhí)行以下操作：

1. 在邊欄中選擇收藏集。
2. 選擇一個請求，然后選擇一個示例將其打開。
3. 對示例請求或響應(yīng)進行任何更改。
4. 選擇保存以保存示例。

要在嘗試后編輯示例，請執(zhí)行以下操作：

1. 在邊欄中選擇收藏集。
2. 選擇一個請求，然后選擇一個示例將其打開。
3. 選擇嘗試在新選項卡中將示例作為請求打開。
4. 對新請求進行任何更改。
5. 選擇發(fā)送。
6. 在響應(yīng)窗格中，選擇保存響應(yīng)，然后選擇更新示例。更新示例后，您將收到確認信息。新請求不會自動保存。
7. 或者，您可以選擇保存以將新請求保存到工作區(qū)中的新集合或現(xiàn)有集合。
8. 選擇保存新請求的位置，然后選擇保存。

復(fù)制一個例子

復(fù)制示例以使用現(xiàn)有示例作為基礎(chǔ)添加新示例。然后您可以編輯復(fù)制的示例以更改名稱、狀態(tài)代碼或請求或響應(yīng)的任何其他部分。

1. 在邊欄中選擇收藏集。
2.  選擇示例旁邊的更多操作圖標 ，然后選擇復(fù)制。
3. 對示例請求或響應(yīng)進行任何更改。
4. 選擇保存以保存示例。

刪除示例

刪除示例會將其從集合和關(guān)聯(lián)的 API 文檔中移除。您設(shè)置的任何模擬服務(wù)器都不能再使用該示例返回響應(yīng)。

1. 在邊欄中選擇收藏集。
2.  選擇示例旁邊的更多操作圖標 ，然后選擇刪除。
3. 選擇刪除進行確認。

在文檔中使用示例

Postman 會自動為您創(chuàng)建的每個集合生成文檔。生成的文檔包括已添加到集合中的任何示例。如果您編輯示例，文檔會根據(jù)您的更改自動更新。

示例為您的 API 提供更多詳細信息和說明，并幫助您的團隊共同開發(fā) API。前端開發(fā)人員、后端開發(fā)人員和測試人員可以并行工作，使用文檔中的示例作為指導(dǎo)或設(shè)置模擬服務(wù)器。

您可以發(fā)布您的文檔，使您的示例對世界上的任何人公開可用。

下一步

您可以使用示例來設(shè)置模擬服務(wù)器并增強您的文檔。

• 要了解如何使用示例來設(shè)置模擬服務(wù)器，請訪問設(shè)置模擬服務(wù)器。
• 要了解如何在您的 API 文檔中包含示例，請訪問記錄您的 API。