JSON Schema

JSON Schema 是一種詞彙，可讓你為 JSON 文件加上註解並進行驗證。它為你的 JSON 資料提供契約，定義其結構、資料類型與驗證規則。

Apidog 使用 JSON Schema 來定義請求與回應主體結構，讓你的 API 能夠自動驗證並產生文件。

外部參考

本頁提供 JSON Schema 的簡要介紹。如需完整的規格詳細資訊、語法與進階功能，請參閱官方 JSON Schema Documentation。

什麼是 JSON Schema？

JSON Schema 是一個強大的工具，可用於：

依照已定義的規則驗證 JSON 資料

記錄預期的 JSON 結構

根據 schema 定義產生 模擬資料

確保一致性，使 API 請求與回應保持一致

為 POST/PUT/PATCH 端點定義請求主體 schema

為所有 HTTP 方法指定回應主體結構

依照預期格式驗證傳入資料

自動產生模擬回應

建立完整的 API 文件

如需 JSON Schema 語法、驗證關鍵字與進階功能的詳細資訊，請參閱官方 JSON Schema Specification Documents。

從定義基本類型與必填欄位的簡單 schema 開始，然後視需要逐步加入驗證規則與限制條件。