JSON Schema検証

JSON Schema検証とは

JSON Schema検証は、JSONデータとSchemaルールを照合し、データの構造や内容があらかじめ定義された条件に適合しているか確認する機能です。たとえば、特定のフィールドを必須にしたり、フィールドを文字列や数値に限定したり、配列要素に特定の構造を要求したり、数値や文字列に範囲などの制約を設定したりできます。

JSONとSchemaの違い

左側には検証したいJSONデータ、右側にはJSON Schemaを入力します。JSONは実際のデータ、Schemaはデータ構造と制約条件を記述したルールです。両方を用意すると、ツールがSchemaに基づいてJSONを検証します。

よく使われるSchemaルール

一般的なルールには、データ型を指定するtype、必須プロパティを指定するrequired、オブジェクトのフィールドを定義するproperties、配列要素を定義するitemsがあります。また、enum、const、minimum、maximum、minLength、maxLengthなどの値に関する制約も使用できます。具体的な対応範囲はページのバリデーター実装に従います。

検証結果の見方

検証に成功した場合、現在のJSONデータが指定されたSchemaルールに適合していることを意味します。検証に失敗した場合は、結果エリアにルールに適合しない位置と理由が表示されるため、必須フィールドの不足、型の不一致、値の制約違反などを確認できます。エラーを確認するときは、まずパスを確認し、そのSchemaルールに従ってJSONデータを修正してください。

JSON Schemaのrequiredの使い方

requiredはオブジェクト内に必ず存在しなければならないプロパティを指定します。たとえばSchemaでrequired: [\"name\"]と設定すると、JSONオブジェクトにnameプロパティが存在する必要があります。requiredが確認するのはプロパティの存在であり、値の型を単独で決定するものではありません。フィールドの型はproperties内のtypeなどのルールで定義します。

propertiesとadditionalProperties

propertiesはオブジェクト内の具体的なフィールドを定義します。たとえばnameを文字列型、ageを数値型として指定できます。additionalPropertiesを使うと、Schemaで定義されていない追加プロパティを許可するかどうかを制御できます。未知のフィールドを禁止したい場合は、オブジェクトSchemaで対応するルールを明示的に設定します。

ローカルJSONファイルを検証する方法

ファイルアップロードタブに切り替え、JSONデータとSchemaそれぞれのローカルファイルを指定できます。ファイルはブラウザ内で読み込まれて検証に使用されるため、ローカル設定ファイル、APIデータ、その他のJSONドキュメントを直接確認できます。1ファイルあたりのサイズ上限はページの案内に従います。

検証に失敗した場合の確認方法

結果にJSON形式エラーが表示された場合は、まず入力内容自体が有効なJSONか確認してください。JSONを解析できてもSchema検証に失敗する場合は、エラーのパスに従って該当フィールドを確認します。よくある問題には、requiredで指定された必須プロパティの不足、typeの不一致、itemsで指定された配列要素の構造不一致、enumにない値、数値や文字列が制約範囲を超えているケースなどがあります。

JSON Schema検証はどのような場面に適していますか？

JSON Schemaは、APIデータの検証、設定ファイルのチェック、フロントエンドとバックエンド間のデータ制約、大量データ処理、開発・テストなどで利用されています。データ構造を先に定義し、Schemaで実際のJSONを検証することで、後続処理に入る前に構造やフィールドの問題を発見できます。