JSON の値を読み取り、それに対応する TypeScript の interface 宣言を書き出すツールです。キーは元のまま残し、オブジェクトの配列は1つのインターフェースにまとめ、一部の要素にしかないキーには ? を付け、型が混在する値はユニオン型にします。
フロントエンドで fetch や axios のレスポンスに型を付けるとき、Next.js の API ルートや Express ハンドラーの戻り値の型を宣言するとき、バックエンドがレスポンス例しか文書化しておらず型定義がないときに使ってください。
型名 にルートのインターフェース名を入力します(例: ChannelHistory)。URL に ?name= として残ります。types.ts などのファイルに保存し、import type { ChannelHistory } from "./types" で使います。{
"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
}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 できます。"a-b"、"2fa")は引用符で囲みます。?:)になります。string | number)になり、null は最後に | null として付け加えます。型が混在する配列は (string | number)[] になります。unknown[] になります。export type Root = RootItem[]; のようなエイリアスも出力します。const res = await axios.get<ChannelHistory>(url) のように型をジェネリクスで渡せば、res.data.messages[0].text が null かもしれないことをエディターが警告してくれます。
SDK や @types パッケージのない社内・社外の API でも、サンプルレスポンスが1つあれば、チームで共有する型定義ファイルを作れます。
Storybook やテストのモック JSON からインターフェースを生成して、コンポーネントの props の型に使えば、モックとコンポーネントがずれたときにコンパイラーが教えてくれます。
number(整数と小数の区別なし)で、日付の文字列は string です。"status": "active" のように値の種類が決まっているフィールドは string で出力されます。リテラルのユニオン("active" | "banned")へは自分で絞り込んでください。Profile2 のような数字の接尾辞が付きます。type エイリアスで出力できますか?type エイリアスを使うのはトップレベルが配列やプリミティブのときだけで、オブジェクトは常に interface になります。この用途なら export interface X { ... } を export type X = { ... }; と書き直しても同じように動きます。
?)と | null を分けているのはなぜですか?意味が異なるからです。? はキーそのものがない(undefined)かもしれないことを、| null はキーはあるが値が null であることを表します。strictNullChecks が有効なら、この2つのケースは別々に扱うことになります。
TypeScript の型は実際のオブジェクトを記述するものなので、キーの名前を変えるとレスポンスと一致しなくなります。コードで camelCase を使いたいなら、マッピング関数の結果用に別の型を定義してください。
このページが出力するのは純粋な型宣言だけです。上部の TypeORM、Sequelize、Mongoose のタブなら、同じ JSON からエンティティやモデルのコードを生成できます。