JSON Schema 驗證工具

依 JSON Schema 驗證 JSON 文件,並精確顯示哪裡不符合規則。

使用範例

檢查 API 回應格式

貼上你的 API 所承諾的 Schema 與一份範例回應,在上線前確認欄位、型別與必填屬性是否真的相符。

除錯失敗的設定檔

當某個工具以模糊的錯誤訊息拒絕你的設定檔時,在這裡依照官方文件的 Schema 進行驗證,準確找出哪個欄位出錯、為什麼出錯。

審查 Pull Request 的資料規格

在核准對共用 JSON 結構的變更之前,貼上更新後的 Schema 與幾筆範例資料,確保不會悄悄破壞既有功能。

依已有文件的 Schema 驗證設定檔

許多 CLI 工具會為其設定檔發布 JSON Schema——將你的設定檔連同公布的 Schema 一起貼上,在執行工具之前找出打字錯誤與型別不符。

為你正在撰寫的 Schema 測試邊界情況

在草擬新的 Schema 時,貼上幾份刻意無效的文件(缺少必要欄位、型別錯誤),確認你的 Schema 確實如預期地拒絕它們。

常見問題

支援哪個 JSON Schema 草案版本?

此工具依照相容性最廣泛的 JSON Schema Draft-07 進行驗證。只有在較新草案(如 2019-09 或 2020-12)中才引入的關鍵字(例如 '$recursiveRef' 或新的陣列寫法 'prefixItems')不會被辨識,可能會被靜默忽略。

我的 Schema 或資料會被傳送到伺服器嗎?

不會。Schema 與文件都完全在你的瀏覽器中使用 ajv 函式庫進行驗證,不會上傳到任何地方。

「無效的 Schema」與驗證失敗有什麼不同?

「無效的 Schema」表示 JSON Schema 本身格式有誤或自相矛盾,因此無法編譯,驗證根本無法執行。驗證失敗則表示 Schema 編譯成功,但你的文件不符合其規則——每一條未通過的規則都會列出在資料中的確切路徑。

像「位置 `/user/age`: must be >= 0」這樣的錯誤該如何解讀?

路徑以 '/' 分隔巢狀鍵值與陣列索引,顯示問題在 JSON 文件中的確切位置。冒號後面的訊息則說明違反了 Schema 中的哪一條規則。

Schema 可以用 $ref 參照另一個 Schema 嗎?

僅限於同一份貼上的文件中,使用本機、同文件的 JSON 指標(如 '#/definitions/address')。外部檔案或 URL 的參照不會被解析,因為不會從網路擷取任何內容。

'additionalProperties: false' 實際上強制執行什麼?

它會讓 Schema 拒絕任何帶有未明確列出的屬性的物件,這是抓出欄位名稱打字錯誤(例如把 'email' 打成 'eamil')的常見方式,否則這類錯誤會悄悄通過。

空的 Schema({})有效嗎?

有效——空的 Schema 完全不施加任何限制,因此每份 JSON 文件都能成功通過驗證。