生成された JSON Schema
検証の結果
使い方
説明
API の開発などで使う JSON Schema を、サンプルの JSON から作ったり、JSON がスキーマに合っているかを確かめたりするツールです。
合っていないときは、どのパス(何行目)で、どんな理由かを一覧にするので、直す場所がすぐ分かります。
操作の手順
- 「スキーマを生成」でサンプルの JSON を貼り付け、「生成する」を押します。「詳細オプション」で、必須のキー・知らないキーの扱い・format の推測・版を選べます
- 生成されたスキーマは、コピー・保存できます。「このスキーマで検証する」を押すと、検証の画面にそのまま移ります
- 「スキーマで検証」で、JSON Schema と JSON データを入れて「検証する」を押します
- エラーの一覧の行を押すと、JSON データのその行が選ばれます
計算方法
- 生成:値の種類から type を決め、オブジェクトは properties と required、配列は中身をまとめて items にします。配列の中で形が違うときは、共通する必須のキーだけを残し、型が混ざるときは type の配列か anyOf にします
- 検証:type・enum・const・数値の範囲(minimum など)・文字列(minLength・pattern・format)・配列(items・prefixItems・contains・uniqueItems など)・オブジェクト(properties・required・additionalProperties・patternProperties・dependentRequired など)・allOf / anyOf / oneOf / not・if / then / else・同じスキーマの中の $ref に対応しています
- unevaluatedProperties・$dynamicRef・外部ファイルへの $ref など、対応していないキーワードは無視して、結果の下に書き出します
ご注意
- 入力した内容はこのブラウザの中だけで処理され、外部のサーバーには送信されません(入力した内容は、次に開いたときのため、この端末のブラウザに保存されます)
- format の検証は、よく使われる形(email・date・date-time・time・uri・uuid・ipv4・ipv6・hostname・regex)だけを、簡易な方法で確かめています
豆知識・背景知識
JSON Schema は、JSON の「形」(どのキーがあり、それぞれがどんな型か)を JSON で書く決まりです。API の仕様書(OpenAPI)や設定ファイルの入力補完、フォームの入力チェックなどで広く使われています。
JSON Schema には版(ドラフト)があり、いまの最新は Draft 2020-12 です。Draft-07 までの「配列の items」は、2020-12 では prefixItems に変わりました。スキーマの先頭の $schema で、どの版で書いたかを示します。
$ref を使うと、同じ形を何度も書かずに済みます。たとえば住所の形を $defs に一度だけ書き、"$ref": "#/$defs/address"で呼び出せます。
みんなの声・ご意見ボックス
「JSON Schema バリデーター&ジェネレーター」について、感想・使いにくいところ・欲しい機能などを気軽に教えてください。
まだ投稿がありません。最初の一言をお待ちしています!
利用にお金はかかりますか?会員登録は必要ですか?
IT'S-Tool・PocketCalc のツールは、すべて無料で、会員登録やログインをせずにお使いいただけます。家計簿の有料プランなど、一部の有料のサービスを使うときだけ、IT'S-Tool アカウントでのログインが必要です。
入力した内容はサーバーに送られていますか?
計算やツールの処理は、お使いのブラウザの中だけで行っています。入力された数値や画像がサーバーへ送られることはありません。
コメント欄に投稿された内容だけは、他の方にも読んでいただくためにサーバーへ保存されます。
コメント欄に投稿された内容だけは、他の方にも読んでいただくためにサーバーへ保存されます。
スマホやタブレットでも使えますか?
iPhone・iPad・Android のブラウザに対応しています。画面の幅に合わせて表示が切り替わります。
要望やバグを見つけたときはどこへ伝えればよいですか?
「投稿する」タブからお知らせください。いただいた内容は運営で確認し、改善の参考にさせていただきます。