エンコード & テキスト
JSON TypeScript 変換
JSON TypeScript 変換とは、JSON サンプルから対応する TypeScript 型を作ることです。左に JSON を貼り、interface か type alias を選ぶと、ネストした interface・配列要素型・オプショナル字段まで自動で書き出します。すべてブラウザ内で完結し、JSON は端末から出ません。
JSON から TypeScript 型定義を導くやり方で、実行時の推測ではなくコンパイラにデータ構造をチェックさせます。
JSON TS 変換ジェネレーターでも TypeScript ジェネレーターでも、結果は同じ:手元のデータ向けの型契約です。
できること
interface と type alias を選択
チームの好みで出力形態を選べます。ネストオブジェクトはネスト interface、配列は名前付き要素型になります。トップレベルだけでなく深い構造まで扱う JSON TypeScript interface ジェネレーターです。
オプショナルと nullable を検出
サンプルは素の schema より多くの情報を持ちます。あるオブジェクトにだけあるフィールドはオプショナル、値と null の両方があるフィールドは nullable ユニオンになります。
型名は自分で決める
ルート型名、PascalCase / camelCase、タブかスペース、シングル/ダブルクォートを指定。そのままコードベースに貼れます。
API レスポンスと大きな JSON に対応
API レスポンス、fixture、設定エクスポートを貼るだけ。深いネストと大きな配列も扱い、概念ごとに型を分けて読みやすくします。
すべてブラウザ内で実行
変換は端末上で完結。アップロード・アカウント・API キー不要、保存もしません。顧客データや認証情報を含む payload も安心して貼れます。
使い方
- 01
JSON を用意。左エディタに貼る、.json をアップロード、または内蔵サンプルで出力形を確認。
- 02
出力を選ぶ。interface か type alias、ルート型名、命名・インデント・クォートを既存コードに合わせる。
- 03
型を取る。クリップボードへコピーするか .ts をダウンロードし、必要な場所で import。
JSON TypeScript 変換について
JSON TypeScript 変換の用途
JSON は「今のデータ形」は示しますが、コードが何を仮定してよいかは示しません。JSON TS ジェネレーターはそのサンプルを、プロジェクトに貼れる型契約にします。
any で推測しない
fetch して代入し、何層も渡すうちに `any` が広がります。フィールド名のtypo はコンパイルエラーではなく実行時の事故になります。サンプルから TypeScript を生成すれば、`response.user.email` はコンパイラが検査します。
ネストは名前付き型に
ネストオブジェクトはそれぞれ名前付き interface になります。`billing.address` はルート横に独立した `Address` 型を生み、読みにくいインライン字面量にはしません。
配列・オプショナル・ルート配列
配列はサンプルから推論した名前付き要素型の配列になります(`BillingAddress[]`)。あるレコードにだけ `nickname` があればオプショナル。ルート配列は `RootType[]` として命名されます。 型生成前に2つの API レスポンスを比べたいときは、先に JSON Diff ツールを開いてください。
interface・type alias・class のどれ?
コードベースに合う出力を選びます。本ツールは interface か type alias を生成します。class 出力はまだありません。
出力 向いている用途 ユニオン 実行時 メモ interface 拡張・マージしうるオブジェクト形状 不可 なし JSON データのデフォルト type alias ユニオン・プリミティブ・単一名前の形状 可 なし 複数型のフィールド向け class メソッドなど実行時振る舞いが必要 可 メソッドとフィールド 本ツールでは未対応 型はバリデーターではない
生成型は貼ったサンプルを表すだけで、API の真実全体ではありません。コンパイル時の契約であり、ネットワークデータが一致するかは実行時に保証しません。
キャストはチェックではない
`data as User` はコンパイラを黙らせるだけです。制御できない API では、生成型に加えて実行時検証を。サンプルを先に整えたいときは JSON フォーマッターを使ってください。
JSON サンプルか JSON Schema か
どちらも TypeScript に着きますが起点が違います。レスポンスや fixture があるならサンプル優先が速い。正式な記述があるなら Schema 優先が正確です。
ソース 起点 精度 ユニオン 使うとき JSON サンプル 手元の実データ サンプルに含まれたもの サンプルが示す範囲 API 探索・試作・fixture の型付け JSON Schema 許可形状の正式記述 Schema 規則に拘束 宣言どおり Schema があり強制が必要
プライベート・高速・無料
100% ブラウザ内
変換はローカル。アップロードも JSON の保存もありません。
登録不要
開いてすぐ変換。アカウント・ログイン・API キーなし。
インストール不要
Node.js も CLI もビルドも不要。ブラウザがある端末なら使えます。
無料・無制限
トライアルもペイウォールも、サンプルサイズ上限もありません。
よくある質問
JSON フォーマッター&バリデーターJSON 差分&比較Base64 エンコーダー&デコーダーすべてのツールホームに戻る