JSON→TypeScript型変換
JSONを貼ると、TypeScriptのinterface(またはtype)を生成します。入れ子はそれぞれ名前つきの型に、配列の要素はキーの和集合にして、無いキーはoptionalに。ルート名・readonlyも指定でき、ブラウザ内だけで動きます。
読み込み中…
次におすすめ
使い方と仕様
JSONを貼ると、その形に合う TypeScript の型を書き出します。入れ子のオブジェクトは、キー名から名前をつけた別の宣言になります("user_name" → UserName、"mail-address" → MailAddress のように、区切りを捨てて先頭を大文字にします)。名前が重なったときは Item2 のように番号をつけ、Date や Array のように標準の型を隠してしまう名前には Type を足します。
配列は、全要素を見て1つの型にまとめます。要素が同じ型なら number[]、混ざっていれば (string | number)[] です。要素がオブジェクトなら、全要素のキーの和集合を1つの型にし、一部の要素にしかないキーは optional(?)にします。同じキーで型が違えば union、null が混ざれば string | null です。空の配列は中身が分からないので unknown[] になり、他の要素と一緒なら、他の要素の型に合わせます。
宣言の形は interface と type を選べます。ルートが配列や文字列のときは、interface では書けないので type になります。キーが識別子として使えないとき(ハイフン・数字始まり・空白・空文字など)は、"mail-address" のように引用符つきで書きます。optional は「?: にする」か「| undefined にする」かを選べ、readonly を付けることも、export を外すこともできます。
限界: JSON は1つのサンプルにすぎないので、生成される型は「このサンプルの形」です。取りうる値すべてを表すとは限りません(たとえば、いつも出てくるとは限らないキーが、サンプルには全部あれば必須になります。値が文字列の列挙のようなものも string です)。数は整数も小数も number です。配列の要素名の単数形は英語の単純な規則(items → item、categories → category)なので、変なときは手で直してください。JSON の数値キー("1", "2")は、JavaScript の規則で数の小さい順に並びます。入力は外部に送らず、ブラウザの中だけで処理します。
作った型は、TypeScript のコンパイラ(strict)に通して、元の JSON の値がその型に代入できることを確かめています。
よくある質問
- オブジェクトの配列で、一部にしかないキーはどうなりますか?
- 全要素のキーを合わせた1つの型にして、一部の要素にしかないキーは optional(key?: T)にします。「| undefined」の形にしたいときは、設定で切り替えられます。
- 値が null のキーは、どんな型になりますか?
- そのサンプルで null だけなら null 型です。配列の別の要素で文字列が入っていれば string | null になります。本当は文字列が入りうるキーでも、サンプルが null だけなら null になるので、必要なら手で直してください。
- interface と type はどちらを選べばいいですか?
- この変換の結果は、どちらも同じ形のオブジェクトを表します。好みやプロジェクトの規約に合わせてください。ルートが配列や値のときだけは、interface では書けないので type になります。
- API のレスポンスを貼っても大丈夫ですか?
- 入力はブラウザの中だけで処理し、外部には送りません。ただし、トークンや個人情報が入っているレスポンスは、貼る前に伏せ字にしておくのが無難です。