JSON'ten TypeScript'e
Bir JSON örneğini TypeScript arayüzlerine veya tür takma adlarına dönüştürün. İç içe nesneler kendi adlandırılmış türlerine dönüşür, nesne dizileri birleştirilerek bazı öğelerde bulunmayan anahtarlar isteğe bağlı hâle gelir ve farklı değer türleri birleşim türlerine dönüşür. Bir API yanıtı yapıştırın, arayüzü veya türü seçin ve doğrudan kodunuza ekleyebileceğiniz bildirimleri kopyalayın.
Sık sorulan sorular
İç içe nesneler nasıl işlenir?
Her iç içe nesne, onu içeren anahtara göre PascalCase biçiminde adlandırılmış kendi bildirimine sahip olur; örneğin address, Address olur. Dizilerdeki nesneler, dizi anahtarının tekil biçimine göre adlandırılır; böylece users, User; categories ise Category olur. Tam olarak aynı alanlara sahip nesneler tek bir bildirimi paylaşır.
Bir özellik ne zaman isteğe bağlı olur?
Bir dizide birden fazla nesne varsa ve bazı nesnelerde bir anahtar yoksa, bu anahtar soru işaretiyle isteğe bağlı olarak işaretlenir. Her öğede bulunan anahtarlar zorunlu kalır. Tek bir nesneyi karşılaştırmak için başka örnek olmadığından, tüm anahtarları zorunludur.
null değerlerin türü nasıl belirlenir?
Örneğinizde değeri null olan bir anahtar null türünde olur; bazı öğelerde null, bazılarında dize olan bir anahtar ise string | null olur. Bir alan gerçek verilerde null olabiliyor ama örneğinizde hiç null değilse, null'ı elle ekleyin veya null içeren bir örnek yapıştırın.
interface mı, type mı seçmeliyim?
Her ikisi de aynı yapıyı tanımlar. Arayüzler genişletilebilir ve birleştirilebilir; birçok stil kılavuzu nesne yapıları için arayüzleri tercih eder. Tür takma adları birleşim türlerinde de kullanılabilir ve bazı ekipler her yerde bunları kullanır. Kod tabanınızda hangisi kullanılıyorsa onu seçin; alanlar aynıdır.
Dizilerin türleri nasıl belirlenir?
Tek türde değerlerden oluşan bir dizi, türün sonuna [] eklenerek ifade edilir; örneğin string[] veya User[]. Birden fazla tür içeren dizi, parantez içinde bir birleşim türüne dönüşür; örneğin (string | number)[]. Boş bir dizi unknown[] olur, çünkü örnek içindeki öğeler hakkında bilgi vermez.
Geçerli tanımlayıcı olmayan anahtarlara ne olur?
Boşluk, tire veya TypeScript tanımlayıcısında izin verilmeyen başka karakterler içeren anahtarlar tırnak içinde yazılır; örneğin "first-name": string. Bu, geçerli bir TypeScript ifadesidir ve JSON ile tam olarak eşleşir.
Sayılar tamsayı mı, kayan noktalı sayı mı olarak türlendirilir?
TypeScript yalnızca tek bir sayı türüne sahiptir; bu nedenle hem tamsayılar hem de ondalık sayılar number olur. Hangi değerlerin tam sayı olduğunu bilmeniz gerekiyorsa JSON Şema Oluşturucu, integer ile number türlerini birbirinden ayırır.
Kök türü yeniden adlandırabilir miyim?
Evet. Kök tür için ApiResponse gibi bir ad girin. Ad PascalCase biçimine dönüştürülür, iç içe türlerse anahtarlarından türetilen adları korur. JSON yapınızın en üst düzeyinde bir dizi veya tek bir değer varsa, kök tür bunun için bir tür takma adı olur.
Tarihler algılanıyor mu?
Hayır. JSON içinde tarih türü olmadığından, örneğinizdeki tarih string olur ve string olarak türlendirilir. Ayrıştırdıktan sonra kodunuzda Date türüne dönüştürün veya şablon dize türü kullanıyorsanız türü elle daraltın.
JSON ne kadar büyük olabilir?
En fazla 1,000,000 karakter olabilir ve 64 düzeye kadar iç içe geçebilir. Örnek yalnızca türleri üretmek için analiz edilir ve saklanmaz.