JSON Schema とは?
JSON Schema は JSON データの形状を記述する語彙です。オブジェクトプロパティ、必須フィールド、型、配列、形式、制約を定義します。API 検証、ドキュメント、モック、テストで使われます。
サンプル JSON から JSON Schema を生成し、Draft 2020-12 または Draft 7 でローカル検証できます。
この実践的 JSON Schema コースで学ぶ内容を紹介します。
このワークフローの関連ガイド: API デバッグにローカルブラウザーツールが役立つ理由
DevCove JSON Schema ジェネレーターは、サンプル JSON を実用的な schema の出発点に変換し、同じワークスペースで別の JSON ドキュメントを検証します。API レスポンス、モック、fixture、設定ファイル、ドキュメント草案に使えます。生成と検証はブラウザー内でローカル実行されます。
実際の JSON 例があり、API 検証、モック、ドキュメント用の schema が必要なときに使います。
再利用可能な検証契約が必要なチーム向けに、JSON フォーマッターとは独立した schema ワークスペースとして設計されています:
JSON Schema は JSON データの形状を記述する語彙です。オブジェクトプロパティ、必須フィールド、型、配列、形式、制約を定義します。API 検証、ドキュメント、モック、テストで使われます。
JSON Schema 仕様のバージョンです。Draft 2020-12 は新規作業のモダンな既定値で、Draft 7 は旧ツールやプラットフォームでよく使われます。このジェネレーターではどちらも選べます。
強力な出発点として扱い、自動契約とはみなさないでください。必須フィールドを確認し、最小長や enum などのビジネスルールを追加し、サンプルで証明できない点を調整してください。
厳密モードでは、そのレベルの全サンプルオブジェクトに現れるプロパティを必須にします。オブジェクト配列では、1 行でも欠けていれば必須になりません。
サンプルが不完全、API フィールドがしばしば任意、または手動でルールを絞る前に許容的な schema が欲しいときに使います。
はい。形式推論が有効なとき、email、URI、UUID、date、date-time などの一般的な形式を追加・検証できます。
いいえ。schema 生成と検証はローカル JavaScript と Ajv でブラウザー内実行されます。DevCove はサンプル、schema、検証データをアップロードまたは保存しません。