Scala Class → JSON Schema 生成

Scala コード 入力

エディターを読み込み中…

JSON Schema 出力

設定

JSON Schema の root として扱う case class を選択します。

解析はブラウザー内で完結します。ソースコードが外部に送信されることはありません。

Scala の case class を貼り付けて JSON Schema を即生成。

Option[T]、コレクション、map、ネストした case class、既定値に対応します。

Scala の case class を JSON Schema に変換する方法 – ステップガイド

このオンライン Scala case class → JSON Schema 変換ツールは、実際のモデル(DTO、struct、class)から JSON Schema を生成し、payload の検証、コントラクト共有、モック JSON 生成に役立ちます。

  1. ステップ 1 – Scala のソースを貼り付ける

    • ドキュメント化したいモデルを左側のエディターに貼り付けます。
    • 参照される型も同じスニペットに含めると、definitions を生成できます。
    • サンプル ボタンで例を読み込み、入力フォーマットを確認できます。
  2. ステップ 2 – ルート型 を選択する(必要な場合)

    • 複数の定義が検出された場合は、API payload に対応する root を選択します。
    • 出力スキーマは選択した root を中心に構築され、参照される型の定義を含むことがあります。
  3. ステップ 3 – JSON Schema 出力を確認する

    • 型、必須/任意フィールド、ネストした object/array 構造を確認します。
    • モデルが他のモデルを参照している場合は、 definitions $ref を確認してください。
    • スキーマをコピーまたはダウンロードして、検証/ドキュメント化/schema‑first 開発に利用します。
  4. ステップ 4 – 検証またはモック JSON を生成する

    • モックデータ生成 」をクリックすると、スキーマを読み込んだ状態でモック生成ツールを開けます。
    • 実 payload をスキーマで検証し、破壊的変更を早期に検出します。
    • 高度な schema 合成(例: anyOf/oneOf/allOf)を使う場合は、Ajv などのフルバリデータで結果を確認してください。

スキーマ keyword 対応に関する注意

生成されたスキーマには $ref が含まれることがあり、編集して anyOf, oneOf, または allOfを追加できます。 複雑なスキーマの場合は、フル機能の JSON Schema バリデータを使い、必要に応じてモック生成前に dereference してください。

関連する JSON Schema/コード生成ツール

スキーマの検証、モック payload の生成、JSON 例の整形、コードとコントラクトの同期に役立つツールです。

よくある質問

対応している Scala の型は?

case class と、コンストラクタ引数を持つ通常の class に対応します。Option[T]、コレクション(List/Seq/Vector/Array/Set)、map、既定値、基本的なプリミティブ型を扱えます。同じスニペット内にあればネストした case class もサポートします。

型推論はどのように動作しますか?

String/Int/Long/Double/Boolean/BigDecimal/Instant/UUID などのプリミティブは、format を伴う JSON Schema のプリミティブに対応します。コレクションは array、map は object、Option[T] は任意フィールドになります。未知の型は、同名の case class が存在しない限り string にフォールバックします。

Scala 3 や古い構文にも対応していますか?

はい。標準的な case class 構文で定義されていれば解析できます。変換はブラウザー内で行われるため、ソースコードは外部に送信されません。

モック JSON データはどう作りますか?

スキーマ生成後に「モックデータ生成」をクリックすると、スキーマを読み込んだ状態で Mock Generator を開けます。ロケール、配列サイズ、任意フィールドを設定して、サンプル payload をすぐに作成できます。

Scala Class → JSON Schema 生成 | JSONSwiss