使用 API 模擬產生回應
啟用 API 模擬後,即可立即使用。
API 模擬會盡可能逼真地回應其收到的任何呼叫。在產生回應主體時,模擬會優先考慮使用者提供的資料,依序尋找 example 欄位、預設值,然後是 enum 欄位。如果找到其中一個,就會將其用作範例,否則將根據所呼叫作業傳回的資料類型產生 JSON 範例。
舉例來說,請考慮如下所示的 Company 資料類型定義。它不包含任何使用者提供的範例。
啟動模擬後,對 /company/{companyId} 資源進行的 GET 呼叫將根據資料類型的結構傳回自動產生的 JSON 回應。
模擬完成了一些有趣的事情,包括為自訂回應標頭 (例如 x-my-custom-header) 產生值、識別陣列並建立適當的範例 (例如 tags 屬性),以及識別巢狀結構並為其產生值 (例如 address 屬性)。
API Designer 模擬支援內容協商,因此您可以使用 Accept 請求標頭在多個選項中選擇應傳回哪個主體 (每個選項可能都有自己的範例),從而變更模擬傳回的範例。
資訊備註備註: 呼叫 API 模擬時,回應標頭名稱的大小寫可能會變更。這不會破壞任何內容,因為 HTTP 標頭名稱不區分大小寫。