示例
開發(fā)人員可以在發(fā)送實際請求或設(shè)置單個端點返回響應(yīng)之前肋层，在Postman中模擬請求和響應(yīng)。在API開發(fā)最早期間建立一個示例需要團隊成員之間的明確溝通拄衰，使其期望達(dá)到一致帅刀，意味著開發(fā)人員和測試人員可以更快地開始使用API。
什么是一個示例扣溺？
一個示例是一個緊密耦合的請求和響應(yīng)對。例如瓜晤，在這個例子中，'200 OK custom response'是一個例子的名字痢掠，它包含一個'示例請求'和'示例響應(yīng)'。
為什么使用示例足画？
通常情況下雄驹，創(chuàng)建和保存幾個示例響應(yīng)以及一個請求（200，404淹辞，500等的狀態(tài)碼）可以讓您的API更容易理解医舆。因此象缀，查看您的API的同事可以快速查看這些示例，并了解特定請求將返回的響應(yīng) ——所有這一切央星，無需在請求上按“發(fā)送”。
此外毙石，假設(shè)您將使用尚不存在的端點構(gòu)建API，或者您的服務(wù)器尚未準(zhǔn)備就緒徐矩。通過示例，您可以模擬原始響應(yīng)并保存它們丧蘸。然后，您可以使用Postman的模擬服務(wù)為每個客戶端生成一個模擬端點刽漂。通過此設(shè)置弟孟，開發(fā)人員可以向模擬端點發(fā)出請求贝咙，并根據(jù)模擬端點返回的模擬響應(yīng)開始前端開發(fā)或編寫測試腳本拂募。
添加一個示例
假設(shè)您正在處理保存在集合中的請求陈症，你只需要向每個API端點點擊幾下即可添加示例。您可以使用新建自定義響應(yīng)或從服務(wù)器收到的響應(yīng)為此請求添加示例录肯。
新建自定義響應(yīng)
通過讓您從頭開始創(chuàng)建自己的自定義響應(yīng)，您可以通過示例來定義響應(yīng)應(yīng)該是什么樣子优炬。下面的圖示概述了創(chuàng)建具有新響應(yīng)的示例的步驟。
- 單擊示例（Examples）下拉列表厅贪。
- 單擊添加示例（Add Example）按鈕蠢护。基本請求作為示例編輯器中的示例請求（example request）加載养涮。
- 輸入你的例子的名字（name）葵硕。
- 編輯示例的請求（request）部分单寂。
- 輸入狀態(tài)碼（status code）。
- 為您的示例創(chuàng)建一個新的響應(yīng)（response）。
- 單擊構(gòu)建器右上角的保存示例（Save Example）按鈕以保存示例昏苏。
從服務(wù)器收到的響應(yīng)
收到服務(wù)器的響應(yīng)后威沫，您可能希望以當(dāng)前請求和響應(yīng)來保存為例洼专。這樣做的步驟類似于從頭開始創(chuàng)建一個新的響應(yīng)。
稍后烟很，您可以返回到您的基本請求蜡镶，并在您離開的位置通過點擊構(gòu)建器左上角的請求名稱繼續(xù)下一步。
訪問您保存的示例
單擊構(gòu)建器右上角的示例（Examples）下拉列表以訪問所有保存的示例芹橡。
“保存響應(yīng)”功能發(fā)生了什么望伦？
Postman具有保存響應(yīng)的功能已經(jīng)很長時間了。但是腿箩，我們的用戶希望在保存之前編輯這些響應(yīng)劣摇，并添加新的響應(yīng)。示例將使所有這些變?yōu)榭赡埽?/p>
響應(yīng)可以保存到示例中饵撑。保存響應(yīng)，像以前一樣垢乙，但現(xiàn)在你可以隨時編輯它們语卤。通過單擊示例（Examples）下拉菜單，訪問已保存的響應(yīng)粹舵。
您的示例如何在Postman文檔中顯示
您可能已經(jīng)知道Postman已經(jīng)有API文檔眼滤，只需點擊一下即可發(fā)布到網(wǎng)絡(luò)上。示例將顯示在您的API文檔中诅需，為您的API提供其他詳細(xì)信息和說明荧库。
您可以隨時返回并編輯這些示例赵刑，并對文檔進(jìn)行實時更新！
這允許團隊模擬示例請求和響應(yīng)蚪战，以及使用模擬服務(wù)器模擬端點铐懊。前端和后端開發(fā)人員和測試人員都可以根據(jù)商定的示例開始并行工作。
