JSON a TypeScript
Obtén declaracions TypeScript a partir d’una mostra JSON, amb unions, propietats opcionals i objectes imbricats. Revisa el resultat abans d’utilitzar-lo com a contracte d’una API.
Eines per a desenvolupadors
JSON a TypeScript
Obtén declaracions TypeScript a partir d’una mostra JSON, amb unions, propietats opcionals i objectes imbricats. Revisa el resultat abans d’utilitzar-lo com a contracte d’una API.
Màxim 200 KiB UTF-8; profunditat màxima: 50 nivells.
.ts
Amb una arrel array o primitiva, el mode interface emet un àlies de tipus arrel.
Els tipus només descriuen la mostra. Les propietats absents són opcionals; null és explícit; els arrays buits utilitzen unknown[]. No valida dades en execució.
02 / Guia d’ús
Sobre aquesta eina
Com s’utilitza aquesta eina
Entrada
Enganxa JSON vàlid o carrega l’exemple amb registres sintètics. Inclou variants representatives de l’estructura que vols descriure.
Opcions
Escriu un nom arrel vàlid, com ApiResponse, i tria interface o type. Les arrels que no són objectes utilitzen un àlies de tipus.
Resultat
Prem Converteix, revisa els opcionals i les unions i copia o descarrega el fitxer .ts. Comprova’l amb el compilador.
Exemple resolt
Exemple resolt · JSON a TypeScript
El segon registre conté active i el primer no; per tant, active és opcional. Els dos tipus observats de tag apareixen a la unió.
Entrada
[{"id":1,"tag":"x"},{"id":2,"tag":null,"active":true}]Resultat
export type ApiResponse = ({
active?: boolean;
id: number;
tag: null | string;
})[];Formats i límits
- Límits
- Màxim 200 KiB UTF-8; profunditat màxima: 50 nivells.
- Opcions
- Tots dos descriuen objectes. Type produeix un àlies; interface produeix una interfície per a una arrel objecte. Una arrel array o primitiva necessita un àlies fins i tot en mode interface.
- Resultat
- Es comparen tots els objectes d’un mateix array. Si una propietat falta en algun, es marca amb ?. Tenir null no equival a l’absència de la propietat.
Problemes habituals
Què passa amb null i els arrays buits?
Null es conserva com a tipus explícit i pot formar una unió. Un array buit es representa com a unknown[] perquè no hi ha elements dels quals inferir el tipus.
Es validen les dades en execució?
No. TypeScript comprova tipus durant el desenvolupament; aquestes declaracions no inspeccionen futures respostes d’una API. Afegeix un validador d’execució si el necessites.
Revisa el resultat abans d’utilitzar-lo
El segon registre conté active i el primer no; per tant, active és opcional. Els dos tipus observats de tag apareixen a la unió.
Formats i límits
Màxim 200 KiB UTF-8; profunditat màxima: 50 nivells. Processament en aquest navegador. No es pugen ni es desen dades.
Preguntes Freqüents
He de triar interface o type?
Tots dos descriuen objectes. Type produeix un àlies; interface produeix una interfície per a una arrel objecte. Una arrel array o primitiva necessita un àlies fins i tot en mode interface.
Com es detecten les propietats opcionals?
Es comparen tots els objectes d’un mateix array. Si una propietat falta en algun, es marca amb ?. Tenir null no equival a l’absència de la propietat.
Què passa amb null i els arrays buits?
Null es conserva com a tipus explícit i pot formar una unió. Un array buit es representa com a unknown[] perquè no hi ha elements dels quals inferir el tipus.
Es validen les dades en execució?
No. TypeScript comprova tipus durant el desenvolupament; aquestes declaracions no inspeccionen futures respostes d’una API. Afegeix un validador d’execució si el necessites.
Què passa si la mostra és incompleta?
El resultat només coneix els valors presents. No descobreix camps futurs, regles de negoci, dates ni enumeracions. Utilitza mostres variades i revisa el contracte real.