JSONをTypeScriptの型に変換!

JSONを入力するとTypeScriptのinterfaceに変換します!TypeScript interface 対応。TypeORM · Sequelize · Mongoose は上のタブから。
JSON
結果
 

JSONをTypeScriptの型に変換!

JSON の値を読み取り、それに対応する TypeScript の interface 宣言を書き出すツールです。キーは元のまま残し、オブジェクトの配列は1つのインターフェースにまとめ、一部の要素にしかないキーには ? を付け、型が混在する値はユニオン型にします。

フロントエンドで fetch や axios のレスポンスに型を付けるとき、Next.js の API ルートや Express ハンドラーの戻り値の型を宣言するとき、バックエンドがレスポンス例しか文書化しておらず型定義がないときに使ってください。

使い方

  1. DevTools の Network タブからコピーしたものなど、レスポンスの JSON を貼り付けます。
  2. 型名 にルートのインターフェース名を入力します(例: ChannelHistory)。URL に ?name= として残ります。
  3. 出力を types.ts などのファイルに保存し、import type { ChannelHistory } from "./types" で使います。

例

入力 (JSON)
{
  "channel": "general",
  "messages": [
    { "id": "m1", "user": "kim", "text": "deploy done", "reactions": ["+1"] },
    { "id": "m2", "user": "lee", "text": null, "edited": true, "attachment": { "type": "image", "url": "https://cdn.example.com/a.png" } }
  ],
  "cursor": 42
}
出力 (TypeScript)
export interface ChannelHistory {
  channel: string;
  messages: Message[];
  cursor: number;
}

export interface Message {
  id: string;
  user: string;
  text: string | null;
  reactions?: string[];
  edited?: boolean;
  attachment?: Attachment;
}

export interface Attachment {
  type: string;
  url: string;
}

2つのメッセージは1つの Message インターフェースにまとめられ、片方にしかない reactions、edited、attachment には ? が付きます。text は文字列と null が混ざっているので string | null です。要素のインターフェースはキーの単数形の名前になります(messages → Message)。

対応機能

  • すべての宣言は export interface なので、他のファイルからすぐ import できます。
  • JSON のキーは名前を変えないので、型はレスポンスのオブジェクトと1対1で一致します。識別子として無効なキー("a-b"、"2fa")は引用符で囲みます。
  • オブジェクトの配列は全要素のキーをまとめ、一部の要素にないキーは省略可能(?:)になります。
  • 型が混在するとユニオン(string | number)になり、null は最後に | null として付け加えます。型が混在する配列は (string | number)[] になります。
  • 空の配列は推論できる要素の型がないので unknown[] になります。
  • トップレベルが配列のときは、export type Root = RootItem[]; のようなエイリアスも出力します。

利用シーン

fetch や axios のレスポンスに型を付ける

const res = await axios.get<ChannelHistory>(url) のように型をジェネリクスで渡せば、res.data.messages[0].text が null かもしれないことをエディターが警告してくれます。

型定義のない外部 API

SDK や @types パッケージのない社内・社外の API でも、サンプルレスポンスが1つあれば、チームで共有する型定義ファイルを作れます。

モックデータとコンポーネントの props

Storybook やテストのモック JSON からインターフェースを生成して、コンポーネントの props の型に使えば、モックとコンポーネントがずれたときにコンパイラーが教えてくれます。

注意点と制限

  • インターフェースはコンパイル時に消えるため、レスポンスが本当にその形をしているかを実行時には確認しません。実行時の検証が必要なら、zod のようなスキーマライブラリと組み合わせてください。
  • 数値はすべて number(整数と小数の区別なし)で、日付の文字列は string です。
  • "status": "active" のように値の種類が決まっているフィールドは string で出力されます。リテラルのユニオン("active" | "banned")へは自分で絞り込んでください。
  • 別々のキーの下にある同じ形のオブジェクトにはそれぞれ専用のインターフェースが作られ、名前が衝突すると Profile2 のような数字の接尾辞が付きます。

よくある質問

インターフェースではなく type エイリアスで出力できますか?

type エイリアスを使うのはトップレベルが配列やプリミティブのときだけで、オブジェクトは常に interface になります。この用途なら export interface X { ... } を export type X = { ... }; と書き直しても同じように動きます。

省略可能(?)と | null を分けているのはなぜですか?

意味が異なるからです。? はキーそのものがない(undefined)かもしれないことを、| null はキーはあるが値が null であることを表します。strictNullChecks が有効なら、この2つのケースは別々に扱うことになります。

キーを camelCase に変換しないのはなぜですか?

TypeScript の型は実際のオブジェクトを記述するものなので、キーの名前を変えるとレスポンスと一致しなくなります。コードで camelCase を使いたいなら、マッピング関数の結果用に別の型を定義してください。

ORM のエンティティ(TypeORM、Sequelize、Mongoose)が必要です。

このページが出力するのは純粋な型宣言だけです。上部の TypeORM、Sequelize、Mongoose のタブなら、同じ JSON からエンティティやモデルのコードを生成できます。