概述 - Apidog Docs

Schema 是 OpenAPI Specification (OAS) 中的基本概念，也常被稱為資料模型（Data Model）。Schema 定義 API 請求與回應物件的預期資料型別和屬性。

JSON Schema 是 Apidog 採用的標準，用於為您的 API 所使用的資料結構建模。

透過 schema，您可以：

定義標準資料結構（例如 Order 物件）。

將 schema 與自動產生的範例整合。

在整個 API 專案中重複運用資料結構。

Apidog 中 Schema 的用途

在 Apidog 中，schema 扮演著關鍵角色：

用途	說明
設計 API	透過在設計階段早期定義 schema，開發者可以視覺化並完善其 API 將處理的資料結構。
模擬服務	Apidog 使用已定義的 schema 來產生模擬回應，讓開發者即使在實際實作之前，也能模擬 API 行為與前端互動。
文件	系統會根據 schema 自動產生準確且完整的 API 文件，協助 API 使用者清楚了解預期的資料格式與結構。
除錯	Schema 用於在 API 除錯中驗證回應，確保 API 回應符合已定義的資料模型。

請考量您的 schema 適用範圍：資料會用於多個 API 區段或 API，還是僅適用於單一使用情境？

如果資料結構預計會有多種用途，建立 schema 有助於集中管理並維持一致性。

您可以在 「Schemas」 目錄下新增 schema。

運用 Apidog 中易於使用的 Schema Editor，有效建構符合 JSON Schema 規格的 schema。

建立可重複使用的 schema 後，請前往端點，在請求或回應主體中，或在其他 schema 中引用這些 schema。透過引用共用資料模型，您可以維持一致性，並簡化資料模型在 API 設計各個元件之間的整合。