JSONからTypeScriptへ

例

入力：

{ "id": 1, "name": "Alice", "age": null, "tags": ["admin", "user"], "address": { "city": "Madrid" } }

出力：

interface User {
  id: number;
  name: string;
  age: number | null;
  tags: string[];
  address: Address;
}

interface Address {
  city: string;
}

型のマッピング

省略可能フィールドと null 許容フィールド

• foo?: string、フィールドがオブジェクトに存在しないことがあります。undefined のチェックが必要です。
• foo: string | null、フィールドは常に存在しますが、明示的に null になることがあります。
• foo?: string | null、存在しない、または null のどちらもあり得ます。

JSON 自体に undefined はありませんが、フィールドの欠落をどう表すかは API によって異なります。使用する API のセマンティクスに合わせてください。

• REST API は通常、欠落したフィールドを省略します -> ?:。
• GraphQL は要求されたすべてのフィールドを常に返します -> | null。
• 一部の SDK は文脈に応じて両方を使い分けます。

ユニオン型とリテラル型

サンプル全体で同じ文字列フィールドが少数の値だけを取る場合（"status": "pending"、"active"、"archived"）、ツールは文字列リテラルのユニオン型を出力できます。

status: "pending" | "active" | "archived";

この動作が必要なら「文字列リテラルのユニオンを推論」を有効にしてください。

よくある間違い

• 1つのサンプルだけから推論する。 すべてのフィールドが必須になり、null 許容性を観測できません。より正確な型を得るには、変化のある 5〜10 個のサンプルを与えてください。
• 空の配列。 "tags": [] は型情報を持たないため、ジェネレーターは unknown[] を出力します。少なくとも1つの要素を含むサンプルを用意してください。
• 型が混在した配列。 [1, "two", true] は (number | string | boolean)[] を生成します。多くの場合、これは JSON に型を付けるのではなく設計を見直すべきことを意味します。
• 数値の文字列キー。 JSON {"1": "a", "2": "b"} は TypeScript では依然としてオブジェクト（Record<string, string>）であり、配列ではありません。ジェネレーターはこれを正しく処理します。