JSON Swiss

JSON Swiss

Ruby Class → JSON Schema 生成

Ruby コード 入力

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

JSON Schema 出力

設定

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

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

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

attr_accessor/attr_reader、ネスト class、メソッドの無視に対応します。

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

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

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

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

  2. ステップ 2 – ルート class を選択する（必要な場合）

    • 複数の定義が検出された場合は、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 例の整形、コードとコントラクトの同期に役立つツールです。

JSON Schema モックデータ生成

スキーマからサンプル JSON を生成し、テストやドキュメントに利用します。

JSON Schema 検証

一般的な schema keyword に対して JSON を検証し、差分を素早く見つけます。

JSON → Ruby クラス

JSON サンプルから Ruby の型・モデルを生成します。

JSON → JSON Schema 生成

代表的な JSON サンプルからスキーマを生成し、モデル起点のスキーマを補完します。

Schema Library

オブジェクト／配列／enum／制約などのスキーマ例とパターンを参照できます。

JSON Formatter

スキーマ検証やドキュメント共有の前に JSON 例を整えます。

よくある質問

対応している Ruby の構文は？

attr_reader/attr_accessor で属性を公開する class を中心に解析します。各属性が JSON Schema の property になります。メソッドなど他の Ruby コードは無視されるため、シンプルなモデル class を安全に貼り付けられます。

属性の型はどう扱われますか？

Ruby は動的型付けのため、既定では schema 上の型は `string` になります。リテラルの既定値があれば型を絞れます。今後は型コメントも読み取る予定です。現時点では DTO の構造を素早く表すためのスキーマを提供します。

このツールを使う理由は？

Ruby のドメインオブジェクトや ActiveModel 風 DTO を他チームと共有する際、JSON Schema があると payload を文書化でき、コントラクト検証にも使えます。この変換はブラウザー内で完結します。

モック JSON payload はどう作りますか？

スキーマ生成後に「モックデータ生成」をクリックすると、スキーマを読み込んだ状態で Mock Generator を開けます。例 payload をすぐに作成できます。

Ruby Class → JSON Schema 生成 | JSONSwiss