JSON a TypeScript

Genera interfaces o tipos de TypeScript a partir de un JSON de ejemplo, con anidados y opcionales.

Se procesa en tu navegador · Compruébalo Sin envíosDatos enviados: 0 · A otros dominios: 0Analítica: no existe · Anuncios: no existe

Prueba un ejemplo

Nombre del tipo raízDeclarar con Exportar (export) Sólo lectura (readonly) Propiedades que faltan en algún elemento → opcionales (?)

JSON

TypeScript

Los tipos se deducen de este ejemplo: un JSON de muestra no cubre todos los casos posibles de tu API.

Aprende

¿Qué es?

TypeScript añade tipos a JavaScript. Cuando consumes una API recibes JSON, y escribir a mano los tipos de cada respuesta es tedioso. Esta herramienta lee un ejemplo y escribe las interface correspondientes: números, textos, listas y objetos anidados.

¿Para qué sirve?

Tipar la respuesta de una API en segundos y obtener autocompletado en el editor.
Detectar errores como user.nmae antes de ejecutar el código.
Documentar la forma de un fichero de configuración o de un mensaje.
Partir de un tipo generado y afinarlo a mano.

¿Cómo funciona por dentro?

Recorre el JSON y deduce un tipo para cada valor. Para una lista, deduce el tipo de cada elemento y los fusiona: si todos son objetos, los junta en uno solo, y las propiedades que no aparecen en todos se marcan como opcionales con ?; si los elementos son de tipos distintos, forma una unión (number | string). Cada objeto anidado se convierte en su propia interfaz con el nombre de la clave que lo contiene.

Errores comunes

Fiarse de un solo ejemplo: si el campo phone no viene en tu muestra, no aparecerá; pega varios elementos de la lista para ver los opcionales.
null en lugar de «puede faltar»: un valor null (note: null) es distinto de una propiedad ausente (note?:).
Tipar las fechas como string: JSON no tiene fechas; llegan como texto y hay que convertirlas tú.
Números grandes: JSON no distingue enteros de decimales y los IDs mayores de 2⁵³ pierden precisión al leerlos en JavaScript.
Tipos en tiempo de compilación, no de ejecución: TypeScript no valida los datos reales; para eso necesitas una librería de validación.

Glosario

Interfaz:: Un tipo de TypeScript que lista las propiedades de un objeto y sus tipos.
Propiedad opcional:: Una propiedad marcada con ? que puede faltar en el objeto.
Unión:: Un tipo que admite varias posibilidades
Inferir:: Deducir los tipos a partir de un ejemplo de datos en lugar de escribirlos a mano.

Para saber más

Más en Conversores

Aprende paso a paso en la rutaFormatos de datos y APIs