JSONスキーマバリデーター

JSONドキュメントがJSON Schemaに適合しているか検証し、どこで失敗したかを確認します。

活用例

APIレスポンスの形を確認する

APIが約束しているスキーマとサンプルレスポンスを貼り付けて、公開前にフィールド・型・必須プロパティが本当に一致しているか確認できます。

設定ファイルのエラーを調べる

ツールが曖昧なエラーで設定ファイルを拒否したとき、ドキュメント化されたスキーマと照らし合わせて、どのフィールドが何故間違っているか正確に特定できます。

プルリクエストのデータ契約をレビューする

共有JSON構造への変更を承認する前に、更新後のスキーマといくつかのサンプルデータを貼り付けて、気づかないうちに壊れる箇所がないか確認できます。

ドキュメント化されたスキーマに対して設定ファイルを検証する

多くのCLIツールは設定ファイル用のJSON Schemaを公開しています。自分の設定ファイルを公開されているスキーマと一緒に貼り付ければ、ツールを実行する前に誤字や型の不一致を見つけられます。

作成中のスキーマのエッジケースをテストする

新しいスキーマを作成している最中に、意図的に無効なドキュメント(必須フィールドの欠落や型の誤りなど)をいくつか貼り付けて、スキーマが期待どおりにそれらを拒否するか確認できます。

よくある質問

どのJSON Schemaドラフトに対応していますか?

このツールは最も広くサポートされ互換性の高いJSON Schema Draft-07で検証します。Draft 2019-09や2020-12など、それ以降のドラフトでのみ導入されたキーワード(例えば'$recursiveRef'や新しい配列形式の'prefixItems')は認識されず、無視される場合があります。

スキーマやデータはサーバーに送信されますか?

いいえ。スキーマとドキュメントは両方ともajvライブラリを使ってブラウザ内だけで検証され、どこにもアップロードされません。

「無効なスキーマ」と検証失敗の違いは何ですか?

「無効なスキーマ」は、JSON Schema自体の形式が不正または矛盾しておりコンパイルできなかったことを意味し、この場合は検証自体が実行されません。検証失敗は、スキーマは正しくコンパイルされたものの、ドキュメントがそのルールを満たしていないことを意味し、失敗した各ルールがデータ内の正確な位置とともに一覧表示されます。

「位置 `/user/age`: must be >= 0」のようなエラーはどう読めばいいですか?

パスは、JSONドキュメント内で問題が発生している位置を、'/'でネストしたキーや配列インデックスを区切って示します。コロンの後のメッセージは、スキーマのどのルールが破られたかを説明しています。

スキーマが$refで他のスキーマを参照できますか?

貼り付けた同一ドキュメント内のローカルなJSON Pointer(「#/definitions/address」のようなもの)でのみ参照できます。外部のファイルやURLの参照はネットワークから何も取得しないため解決されません。

「additionalProperties: false」は実際に何を強制しますか?

明示的に列挙されていないプロパティを持つオブジェクトを拒否するようにします。これは、そのままでは見逃してしまうフィールド名の誤字(「email」のつもりが「eamil」になっているなど)を見つけるためによく使われる方法です。

空のスキーマ({})は有効ですか?

はい。空のスキーマは制約を一切課さないため、あらゆるJSONドキュメントがこれに対して検証に成功します。