JSONをEffect Schemaに変換

JSONの形からEffect Schemaコードを作る

このツールは、入力したJSONサンプルのフィールド名、値の種類、オブジェクトの入れ子、配列の形を読み取り、TypeScriptのEffect Schema向けコードを生成します。JSONを貼り付けると結果が自動で更新され、型名を指定すれば出力のルート名も調整できます。コードはコピー、またはTypeScriptファイルとしてダウンロードできます。

たとえば {"name":"Aki","age":30,"active":true} のような値から、文字列・数値・真偽値を含む構造を組み立てる出発点を得られます。配列やネストしたオブジェクトもサンプルに現れている形に沿ってコード化されます。

Schemaは型注釈だけではない

Effect SchemaのSchemaは、データ構造を表す値としてプログラム内で利用でき、公式ドキュメントではデコードやエンコードなどの操作も説明されています。生成されたコードは、そのSchemaを作るためのたたき台です。JSONの見た目だけから、メールアドレスの形式、数値の許容範囲、業務上の必須条件まで決めるものではありません。

サンプルを整えてコードを確認する

1. 入力欄に完全なJSONテキストを貼り付けます。キーと文字列は二重引用符で囲み、カンマや括弧を閉じてください。整形ボタンでインデントをそろえたり、サンプルボタンで例を読み込んだりできます。

2. 必要に応じてルート型名を変更します。初期値は Root です。詳細設定では「型定義のみ」などの推論オプションを確認できます。設定項目を変えた場合は、生成コードの内容も見直してください。

3. 出力欄でフィールド名、配列要素、入れ子の構造を確認し、コピーまたはダウンロードします。JSONの構文が正しくない場合はエラーが表示され、コード出力は空になります。入力を直してから結果を確認してください。

複数の値を見比べてから使う

一件のサンプルに存在しないフィールドや別の値のパターンは、その一件だけでは判断できません。任意項目や値の揺れがあるAPIレスポンスなら、代表的な複数ケースを確かめ、必要なフィールドがそろう形を入力に含めて生成結果を比較します。そのうえで、実際の契約に合わせてコードを調整してください。

入力と生成結果について

サンプルから分からない制約を補う

生成結果が反映するのは入力例から推測できる形です。サンプルにない項目、条件付きの必須フィールド、数値の上下限、文字列の書式、相互依存する値や業務上の列挙規則は、API仕様や要件から確認して追加してください。複数サンプルを比較しても、仕様書の代わりにはなりません。

出力コードは実行時の検証を済ませたデータではありません。プロジェクトが使うEffectのバージョンや記法に合うかを確認し、型チェックと実データでのテストを行ってから利用してください。入力に個人情報や秘密情報を含める場合は、貼り付ける前に内容を確認し、必要なフィールドだけのサンプルに置き換えてください。