JSON Schema ツール

JSON Schema ツールの使い方 – ステップガイド

JSON Schema を使って API コントラクトを文書化し、JSON payload を検証し、テストやデモ用のリアルなモックデータを生成できます。

  1. ステップ 1 – 実データのサンプルから始める

    • 実際の API レスポンスやリクエスト payload、設定 JSON をまず formatter に貼り付けます。
    • エンドポイントごとに 1 つの代表 JSON を維持して、スキーマのドリフトを防ぎます。
  2. ステップ 2 – ベースとなるスキーマを生成する

    • Schema Generator を使って型、必須フィールド、ネスト構造を推定します。
    • 本番向けに説明、format、制約(min/max、pattern など)を調整します。
  3. ステップ 3 – スキーマで JSON を検証する

    • Schema Validator にスキーマと実際の payload を貼り付けます。
    • JSON サンプル側(バグ)かスキーマ側(契約変更)を更新してエラーを解消します。
  4. ステップ 4 – テスト用のモックデータを生成する

    • Mock Generator を開き、スキーマに一致するリアルなサンプル payload を生成します。
    • seed と batch size を使うと、テストデータを再現可能かつスケーラブルにできます。
  5. ステップ 5 – 共有して再利用する

    • スキーマをバージョン管理し、API ドキュメントからリンクして再利用します。
    • 安定した JSON 例から TypeScript/Java などの型付きコードを生成します。

JSON Schema 機能に関する重要な注意

  • 一部のスキーマは $ref, anyOf, oneOf, allOfなどの高度な keyword に依存します。
  • Validator によって draft や keyword の対応範囲は異なります。厳密な検証が必要な場合は、CI でフル機能の JSON Schema バリデータを利用してください。
例:JSON → JSON Schema(簡略版)
// JSON input
{
  "id": 1,
  "name": "Maeve Winters",
  "active": true,
  "tags": ["developer", "backend"]
}

// Generated schema (example)
{
  "type": "object",
  "properties": {
    "id": { "type": "integer" },
    "name": { "type": "string" },
    "active": { "type": "boolean" },
    "tags": {
      "type": "array",
      "items": { "type": "string" }
    }
  },
  "required": ["id", "name", "active", "tags"]
}

関連する JSON Schema/検証ツール

スキーマ生成、データ検証、モック payload 作成、安定した JSON からの型付きコード生成に役立つツールです。

よくある質問

JSON Schema とは何ですか?

JSON Schema は、JSON ドキュメントに注釈を付けたり検証したりするための仕様(語彙)です。アプリケーションが必要とする JSON データの契約(コントラクト)を表現できます。

スキーマを生成するのと検証するのは、いつ使い分けますか?

既存の JSON データから検証ルールを作りたい場合は生成を使います。すでにスキーマがあり、JSON がそのルールに従っているか確認したい場合は検証を使います。

Generator と Validator の違いは?

Schema Generator はデータから新しい JSON Schema を作成します。Schema Validator は既存のスキーマのルール/制約に対して JSON をチェックします。

他ツールで作ったスキーマも使えますか?

はい。両ツールは標準的な JSON Schema 形式(Draft 4 / 6 / 7 / 2019-09 など)に対応しているため、他のアプリからインポートしたり、エクスポートして再利用できます。

JSON Schema ツール | JSONSwiss