JSONをTypeScriptに変換
JSONのサンプルからTypeScriptのインターフェースを生成します。
使用例
APIレスポンスの型をすばやく下書きする
サーバーから受け取ったJSONレスポンスの例を貼り付けると、そのままプロジェクトに使えるTypeScriptインターフェースの下書きが得られます。
ネストしたオブジェクトも自動で別のインターフェースに分割する
JSONの中に別のオブジェクトが含まれていると、そのフィールド名をもとに専用のインターフェースを作成し、すっきり整理します。
配列内オブジェクトのフィールドが異なる場合はオプショナルにする
配列内のオブジェクトごとにフィールド構成が少し違う場合、すべての要素に存在しないフィールドには自動で「?」のオプショナル表示が付いた1つのインターフェースにまとめられます。
GraphQLやWebhookペイロードの型を素早く試作する
'{"event": "order.created", "data": {"id": "ord_1", "total": 42.5}}'のようなサンプルペイロードを貼り付ければ、手で書かなくてもWebhookハンドラー用の型付きインターフェースをすぐに得られます。
null値がどう型付けされるか確認する
サンプルに'{"middleName": null}'のようなフィールドを含めてみれば、生成されたインターフェースでnull許容フィールドがどう表現されるか確認できます。
クイックリファレンス
JSON values → TypeScript types
| JSON | TypeScript |
|---|---|
| "hello" | type Root = string; |
| 42 | type Root = number; |
| 3.14 | type Root = number; |
| true | type Root = boolean; |
| null | type Root = null; |
| [] | type Root = unknown[]; |
| [1, 2, 3] | type Root = number[]; |
| ["a", "b"] | type Root = string[]; |
| [1, "a", true] | type Root = (number | string | boolean)[]; |
| [1, null] | type Root = (number | null)[]; |
| [[1, 2], [3]] | type Root = number[][]; |
| {} | interface Root { } |
JSON objects → TypeScript interfaces
| JSON | TypeScript |
|---|---|
| {"id": 1, "name": "Ada"} | interface Root { id: number; name: string; } |
| {"deletedAt": null} | interface Root { deletedAt: null; } |
| {"tags": ["a", "b"]} | interface Root { tags: string[]; } |
| {"user": {"id": 1}} | interface User { id: number; } interface Root { user: User; } |
| {"items": [{"id": 1}, {"id": 2, "note": "x"}]} | interface Item { id: number; note?: string; } interface Root { items: Item[]; } |
| {"categories": [{"name": "x"}]} | interface Category { name: string; } interface Root { categories: Category[]; } |
| {"first-name": "Ada"} | interface Root { "first-name": string; } |
| {"a": {"x": 1}, "b": {"x": 2}} | interface A { x: number; } interface Root { a: A; b: A; } |
よくある質問
入力したJSONはサーバーに送信されますか?
いいえ。すべての変換はブラウザ内でのみ行われ、入力した内容がサーバーに送信されることはありません。
生成されたコードはそのまま使えますか?
1つのJSON例だけから推論した結果のため、実際のデータが取りうるすべてのパターンを完全には反映できない場合があります。生成されたインターフェースは出発点として、必要に応じて調整してご利用ください。
日付の文字列もDate型として認識されますか?
いいえ。JSONには専用の日付型がないため、すべての文字列はstringとして扱われます。日付として扱いたい場合は生成されたコードを直接修正してください。
同じ形のオブジェクトが何度も出てくるとどうなりますか?
構造が同じオブジェクトは重複したインターフェースを作らず、1つのインターフェースを再利用します。
空の配列はどう型付けされますか?
空の配列は要素の型を推測する手がかりがないため、'unknown[]'として型付けされます。より具体的な要素の型がほしい場合は、配列に少なくとも1つサンプル要素を追加してください。
null値はどんなTypeScriptの型になりますか?
サンプル値がnullのフィールドは'null'として型付けされます。そのフィールドが文字列や値が存在しない場合など他の型も取りうるとわかっている場合は、生成された型を手動で'string | null'のように広げる必要があります。
JSON内のフィールドの順序は生成されるインターフェースに影響しますか?
いいえ。生成されたインターフェース内のフィールドは入力に現れた順に並びますが、元のJSONでの並び替えが生成される型自体に影響することはありません。