JSON a TypeScript
Obtén declaraciones TypeScript a partir de una muestra JSON, con uniones, propiedades opcionales y objetos anidados. Revisa el resultado antes de usarlo como contrato de una API.
Desarrollo
JSON a TypeScript
Obtén declaraciones TypeScript a partir de una muestra JSON, con uniones, propiedades opcionales y objetos anidados. Revisa el resultado antes de usarlo como contrato de una API.
Máximo 200 KiB UTF-8; profundidad máxima: 50 niveles.
.ts
Con una raíz array o primitiva, el modo interface emite un alias de tipo raíz.
Los tipos solo describen la muestra. Las propiedades ausentes son opcionales; null es explícito; los arrays vacíos usan unknown[]. No valida datos en ejecución.
02 / Guía de uso
Acerca de esta herramienta
Cómo usar esta herramienta
Entrada
Pega JSON válido o carga el ejemplo con registros sintéticos. Incluye variantes reales de la estructura que quieres representar.
Opciones
Escribe un nombre raíz válido, como ApiResponse, y elige interface o type. Las raíces no objeto utilizan un alias de tipo.
Resultado
Pulsa Convertir, revisa los opcionales y las uniones y copia o descarga el archivo .ts. Compruébalo con tu compilador.
Ejemplo resuelto
Ejemplo resuelto · JSON a TypeScript
El segundo registro contiene active y el primero no, por lo que active es opcional. Los dos tipos observados de tag aparecen en la unión.
Entrada
[{"id":1,"tag":"x"},{"id":2,"tag":null,"active":true}]Resultado
export type ApiResponse = ({
active?: boolean;
id: number;
tag: null | string;
})[];Formatos y límites
- Límites
- Máximo 200 KiB UTF-8; profundidad máxima: 50 niveles.
- Opciones
- Ambos describen objetos. La opción type produce un alias; interface produce una interfaz para una raíz objeto. Una raíz array o primitiva necesita un alias incluso en modo interface.
- Resultado
- Se comparan todos los objetos de un mismo array. Si una propiedad falta en alguno, se marca con ?. Tener null no equivale a que falte la propiedad.
Problemas frecuentes
¿Qué ocurre con null y arrays vacíos?
Null se conserva como tipo explícito y puede formar una unión. Un array vacío se representa como unknown[] porque no hay elementos de los que inferir el tipo.
¿Se validan los datos en ejecución?
No. TypeScript comprueba tipos durante el desarrollo; estas declaraciones no inspeccionan futuras respuestas de una API. Añade un validador de ejecución si lo necesitas.
Revisa el resultado antes de usarlo
El segundo registro contiene active y el primero no, por lo que active es opcional. Los dos tipos observados de tag aparecen en la unión.
Formatos y límites
Máximo 200 KiB UTF-8; profundidad máxima: 50 niveles. Procesamiento en este navegador. No se suben ni guardan datos.
Preguntas Frecuentes
¿Debo elegir interface o type?
Ambos describen objetos. La opción type produce un alias; interface produce una interfaz para una raíz objeto. Una raíz array o primitiva necesita un alias incluso en modo interface.
¿Cómo se detectan las propiedades opcionales?
Se comparan todos los objetos de un mismo array. Si una propiedad falta en alguno, se marca con ?. Tener null no equivale a que falte la propiedad.
¿Qué ocurre con null y arrays vacíos?
Null se conserva como tipo explícito y puede formar una unión. Un array vacío se representa como unknown[] porque no hay elementos de los que inferir el tipo.
¿Se validan los datos en ejecución?
No. TypeScript comprueba tipos durante el desarrollo; estas declaraciones no inspeccionan futuras respuestas de una API. Añade un validador de ejecución si lo necesitas.
¿Qué pasa si la muestra está incompleta?
El resultado solo conoce los valores presentes. No descubre campos futuros, reglas de negocio, fechas ni enumeraciones. Usa muestras variadas y revisa el contrato real.