TypeScript Class → JSON Schema 生成

TypeScript コード 入力

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

JSON Schema 出力

設定

JSON Schema の root として扱う interface/type を選択します。

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

TypeScript の型を貼り付けて JSON Schema を即生成。

interface/type alias/public class フィールド、optional/readonly 修飾子、union 型に対応します。

TypeScript の interface / type / class を JSON Schema に変換する方法 – ステップガイド

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

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

    • ドキュメント化したいモデルを左側のエディターに貼り付けます。
    • 参照される型も同じスニペットに含めると、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 例の整形、コードとコントラクトの同期に役立つツールです。

よくある質問

対応している TypeScript 構文は?

interface、type alias、public フィールドを持つ class を解析します。optional プロパティ、readonly 修飾子、文字列リテラルキー、union 型、配列、Record 型、ネスト参照に対応します。コメントやデコレーターは無視されるため、プロジェクトの DTO をそのまま貼り付けられます。

型マッピングはどうなりますか?

プリミティブ(string/number/boolean/bigint/Date)は適切な format を伴う schema のプリミティブに対応します。配列(Foo[]/Array<Foo>)、Record<string, T>、辞書形は array/object になります。null/undefined を含む union は自動的に任意として扱われます。

class でも interface でも使えますか?

はい。型注釈付きの public フィールド(または readonly プロパティ)を定義していれば、JSON Schema に変換されます。処理はブラウザー内で完結するため、コードは外部に送信されません。

スキーマからモック JSON を作るには?

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

TypeScript Class → JSON Schema 生成 | JSONSwiss