JSONからTypeScriptへ
JSONのサンプルを、TypeScriptのインターフェースまたは型エイリアスに変換します。ネストされたオブジェクトはそれぞれ独立した名前付き型になり、オブジェクトの配列は統合されて、一部の要素にないキーは省略可能になります。型が混在する値はユニオン型になります。APIのレスポンスを貼り付け、interfaceまたはtypeを選んで、コードにそのまま追加できる宣言をコピーしてください。
よくある質問
ネストされたオブジェクトはどのように処理されますか?
ネストされたオブジェクトごとに宣言が作成され、格納しているキーをもとにPascalCaseで名前が付けられます。たとえば、addressはAddressになります。配列内のオブジェクトには、配列キーの単数形が名前に使われるため、usersはUser、categoriesはCategoryになります。フィールドが完全に同じオブジェクトは、1つの宣言を共有します。
プロパティが省略可能になるのはどのような場合ですか?
配列に複数のオブジェクトがあり、一部のオブジェクトにキーがない場合、そのキーは疑問符を付けて省略可能として示されます。すべての要素にあるキーは必須のままです。単一のオブジェクトには比較対象となるサンプルがないため、すべてのキーが必須になります。
null値はどのような型になりますか?
サンプルでnullになっているキーはnull型になります。一部の要素ではnull、ほかの要素では文字列になっているキーは、string | nullになります。実際のデータではnullになる可能性があるものの、サンプルにはnullが含まれていないフィールドは、手動でnullを追加するか、nullを含むサンプルを貼り付けてください。
interfaceとtypeのどちらを選べばよいですか?
どちらも同じ形状を表します。interfaceは拡張やマージが可能で、多くのスタイルガイドではオブジェクトの形状にinterfaceを推奨しています。typeエイリアスはユニオン型にも使え、チームによってはすべてにtypeを使っています。コードベースで使われている方を選んでください。フィールドはどちらも同じです。
配列はどのような型になりますか?
1種類の値を含む配列は、その型の後ろに[]を付けた型になります。たとえば、string[]やUser[]です。複数の型を含む配列は、(string | number)[]のように、ユニオン型を括弧で囲んだ型になります。空の配列はunknown[]になります。サンプルから要素の情報が得られないためです。
有効な識別子ではないキーはどうなりますか?
スペースやハイフンなど、TypeScriptの識別子に使えない文字を含むキーは、"first-name": stringのように引用符で囲まれます。これは有効なTypeScriptであり、JSONと完全に一致します。
数値は整数型と浮動小数点数型のどちらになりますか?
TypeScriptの数値型は1種類のみなので、整数も小数もnumberになります。どの値が整数かを判別する必要がある場合は、JSONスキーマジェネレーターを使うと、integerとnumberを区別できます。
ルート型の名前を変更できますか?
はい。ApiResponseのようなルート型の名前を入力してください。名前はPascalCaseに変換され、ネストされた型にはキーから導出された名前が付けられます。JSONのトップレベルが配列または単一の値の場合、ルートはその型のエイリアスになります。
日付は検出されますか?
いいえ。JSONには日付型がないため、サンプルの日付は文字列として扱われ、string型になります。解析後にコード内でDateに変換するか、テンプレートリテラル型を使っている場合は手動で型を絞り込んでください。
JSONのサイズ上限はどれくらいですか?
最大1,000,000文字で、ネストは最大64階層です。サンプルは型の生成にのみ使用され、保存されません。