如何使用 JSON Schema 驗證您的資料
什麼是 JSON Schema?
JSON Schema 是一種標準化的方法,用來描述您的 JSON 資料的結構、必填欄位與值類型。可將其視為有效 JSON 資料的合約或藍圖。JSON Schema 本身也是以 JSON 格式撰寫,方便機器解析且易於編輯。
JSON Schema 不僅用於驗證,也適用於程式碼產生、API 文件撰寫及編輯器的自動完成。
為什麼要用 Schema 驗證?
- 避免因無效或遺漏的資料引發錯誤。
- 確保跨團隊、應用程式或 API 的資料一致性。
- 從 Schema 自動產生文件說明。
- 協助編輯器與工具提供更完善的自動完成與內嵌說明。
即使簡單的 Schema 也能抓出常見錯誤,為您省下後續大量除錯時間。
簡單範例:基本 Schema
下面是一個基本的 JSON 物件,及一個用來驗證其結構的最簡 Schema:
{
"name": "Alice",
"age": 30
}
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "number" }
},
"required": ["name", "age"]
}
此 Schema 保證該物件必須包含 'name'(字串)與 'age'(數字)兩個欄位。
如何撰寫自訂 Schema
您可以在 Schema 中定義進階規則:限制欄位值、定義巢狀物件,或設定最小/最大數字。以下為驗證產品陣列的範例:
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "string" },
"price": { "type": "number", "minimum": 0 },
"tags": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["id", "price"]
}
}
從簡單開始:逐步建立您的 Schema,並使用線上驗證工具檢查每個步驟。
如何使用 JSONValidator.dev 進行 Schema 驗證
- 將您的 JSON 資料貼到主編輯器中。
- 將 JSON Schema 貼到下方的 Schema 編輯器。
- 點擊 依此 Schema 驗證 JSON 按鈕。
- 檢視驗證結果,任何錯誤會被標示並說明。
所有驗證皆在您的瀏覽器中完成,資料不會離開您的裝置。
Schema 驗證錯誤排除
常見驗證錯誤原因包括:
- 資料中缺少必填欄位。
- 欄位值類型與 Schema 不符(例如字串與數字)。
- Schema 本身無效或含有錯字。
請仔細檢查錯誤訊息,通常會指出確切的欄位與類型不符。
結語
JSON Schema 驗證是讓您的資料更堅固、避免錯誤的強大工具。立即使用我們的免費 JSON Schema 產生器 為您的資料創建 Schema 並即時驗證!