JSON Schemaとは?

JSON Schemaは、JSONドキュメントの構造を記述します。オブジェクトが持つプロパティ、そのうち必須のもの、各値の型、許可される範囲や長さ、メールアドレスや日付などのパターンや形式を定義します。API、設定ファイル、フォーム作成ツールは、データを信頼する前にスキーマを使って検証します。また、OpenAPIではリクエストとレスポンスの本文をスキーマで記述します。

バリデーターの使い方

  1. 1つ目のボックスにJSON Schemaを貼り付けるか入力します。
  2. 2つ目のボックスに検証するJSONデータを貼り付けるか入力します。
  3. 入力すると結果が表示されます。JSONが有効であること、またはすべてのエラーとともに、失敗した値のパス、違反したスキーマキーワード、簡潔な説明が表示されます。
  4. 失敗した値はデータ内で強調表示されます。エラーをクリックすると該当箇所までスクロールし、マークをクリックするとエラー一覧の該当項目を確認できます。

「Schema version」欄には、データの検証に使用したJSON Schemaのドラフトが表示されます。

対応しているドラフト

スキーマの$schemaキーワードでドラフトを指定します。

  • ドラフト2020-12:https://json-schema.org/draft/2020-12/schema
  • ドラフト2019-09:https://json-schema.org/draft/2019-09/schema
  • ドラフト7:http://json-schema.org/draft-07/schema#
  • ドラフト6:http://json-schema.org/draft-06/schema#

$schemaのないスキーマはドラフト7として検証されます。ドラフト4以前には対応していません。まずスキーマ自体を、そのドラフトのメタスキーマに照らして検証します。そのため、"type": "strin"のようなタイプミスは無視されず、無効なスキーマとして報告されます。title、description、examplesなどの注釈や、独自のx-注釈のようにドラフトで認識されないキーワードは問題ありません。これらは無視されます。

エラーの読み方

  • パスはドキュメント全体を表す$から始まるJSONPathで記述されます。たとえば、$.ingredients[1].unitは2つ目の材料のunitを指します。
  • 必須プロパティがない場合、そのプロパティが必要なオブジェクトに対して報告され、メッセージにはプロパティ名が含まれます。
  • スキーマで許可されていない余分なプロパティがある場合、そのプロパティ名が示されます。
  • enumとconstでは、メッセージに許可される値が表示されます。
  • anyOfとoneOfでは、失敗した各分岐についてエラーが追加され、最後にキーワード自体のエラーも追加されます。そのため、1つの誤った値に対して複数のエラーが表示されることがあります。

エラーメッセージはAjvライブラリによるもので、英語で表示されます。

形式

formatが指定された値も検証されます。対応する形式には、email、uri、uri-reference、date、time、date-time、duration、uuid、ipv4、ipv6、hostname、regex、json-pointerなどがあります。JSON Schemaの仕様で認められているとおり、バリデーターが認識しない形式は無視されます。

参照

$refは、#/$defs/addressや#/definitions/addressのように、同じスキーマ内の定義を参照できます。他のファイルやURLへの参照は取得されません。解決できない参照が必要なスキーマは、無効として報告され、その参照先も示されます。

仕組み

このツールは、広く使われているJSON SchemaバリデーターのAjvで検証し、ajv-formatsで形式もチェックします。すべての処理はブラウザー内で行われ、スキーマやデータがアップロードされることはありません。

機能

  • $schemaに基づくJSON Schemaドラフト6、7、2019-09、2020-12への対応
  • パス、キーワード、メッセージを含むすべてのエラーを表示
  • データ内で失敗した値を強調表示し、クリックで該当箇所までスクロール
  • メールアドレス、URI、日付、UUID、IPアドレスなどの形式を検証
  • スキーマをメタスキーマに照らして検証
  • JSON構文エラーの行番号と列番号を表示
  • ブラウザー内で動作