JSON → TypeScript 型生成
JSONデータからTypeScriptのinterface/type定義を自動生成する無料オンラインツール。
JSONを入力してください...
ネスト・配列・任意プロパティ(?)を自動判定、APIレスポンスの型定義を一瞬で作成。手書きの数十行を数秒に、React/Next.js/Node.js開発の効率化に、ブラウザ完結で外部送信なし。
JSONのサンプルから TypeScript の interface または type 定義を自動で生成するツールです。APIレスポンスの型付けを一瞬で終わらせられ、開発効率を大きく上げられます。
JSON → TypeScript 型生成の機能と特徴
APIレスポンスの型定義が必要な理由
TypeScriptで開発するとき、APIレスポンスの型定義があると次のような大きなメリットがあります。
- エディタが補完してくれる
- 間違ったプロパティ名でエラーが出る
- 実行前にバグが見つかる
ただ、複雑なAPIレスポンスの型を手で書くのは大変。本ツールでJSONサンプルから自動生成すれば、開発の最初のステップが数秒で完了します。
interfaceとtypeの違い・どちらを使うか
両方選べます。
- interface はオブジェクトの形を定義するのに一般的で、後から拡張(
extends)できる特徴があります。 - type は複雑な型(ユニオン型・条件型など)が必要なときに使います。
React・Next.js のプロジェクトなら interface が定番ですが、プロジェクトの規約に合わせて選んでください。
任意プロパティ(?)の自動判定
配列内のオブジェクトを解析するとき、「あるオブジェクトにはあって、別のオブジェクトにはないプロパティ」は自動的に ?(任意)マークがつきます。
例えばユーザー配列で一部のユーザーだけが avatar を持っている場合、avatar?: string と生成されます。実データに基づいた現実的な型が得られます。
JSON Schemaやパス一覧も欲しいとき
JSONのバリデーションスキーマが欲しい場合は JSON Schema生成 が向いています。
JSONの中身のパスを一覧で確認したい場合は JSONPath検索 が便利です。
JSONを整形・確認するには JSON整形ツール をお使いください。
JSON → TypeScript 型生成に関するよくある質問
interfaceとtypeはどっちを選べば良い?
オブジェクトの形状を定義する用途なら interface が一般的です。後から
extendsで拡張できたり、同名でマージできる性質があり、Reactのpropsや状態定義でよく使われます。type は「文字列 or 数値」のような複雑なユニオン型を扱いたい場合に有利です。
迷ったら interface でOK、それで型システムに困ることはほぼありません。
ネストされたJSONも変換できますか?
はい、深くネストされたオブジェクトも再帰的に解析し、各階層ごとに別のinterface/typeを生成します。
名前も自動でつけられるので、そのままファイルに貼り付けて動作します。ネストが深いAPIレスポンスほど、手書きに比べた時短効果が大きくなります。
配列の型はどう判定されますか?
配列の全要素を見て、共通する型を推論します。要素が全て同じ型なら
T[]、異なる型が混在していれば(T | U)[]のようなユニオン配列になります。空の配列は
unknown[]になるので、必要に応じて手動でstring[]などに置き換えてください。生成された型はそのまま使えますか?
はい、そのままコピーして .ts ファイルに貼り付ければ動きます。
ただし null と undefined の区別、日付文字列と Date オブジェクトの区別、正確な数値範囲などはJSONからは推測できないため、必要に応じて手動で微調整してください。
nullが混じっている場合はどうなりますか?
nullが含まれるプロパティはstring | nullのようなユニオン型で生成されます。例えば
{"name": null}から生成する場合はname: null、[{"name":"A"},{"name":null}]から生成する場合はname: string | nullになります。実データの多様性を反映した型が得られます。
JSON以外の形式にも対応していますか?
本ツールはJSONのみ対応です。
YAML なら YAML⇔JSON変換 で先にJSONに変換、CSVなら CSV⇔JSON変換 で先に変換してからご利用ください。
JSON Schemaが欲しい場合は JSON Schema生成 が向いています。
JSON → TypeScript 型生成の使い方
-
型にしたいJSONを貼り付け
左側の入力欄に、型を作りたいJSONを貼り付けます。実際のAPIレスポンスや設定ファイルのサンプルを使うと、実用的な型定義が得られます。
-
ルート名とinterface/typeを選ぶ
「ルート名」で最上位の型名(デフォルト
Root)、「出力形式」で interface か type かを選択します。プロジェクトの規約に合わせて選んでください。 -
型定義をコピーして貼り付け
右側にTypeScriptの型定義がリアルタイムで表示されます。「コピー」ボタンでクリップボードにコピーし、あなたのプロジェクトの .ts ファイルに貼り付けて使えます。
カテゴリ データ形式