JSON a TypeScript
Genera una interfaz de TypeScript a partir de un ejemplo JSON.
Ejemplos de uso
Esbozar rápidamente un tipo para una respuesta de API
Pega un ejemplo de respuesta JSON de tu servidor y obtén un borrador de interfaz de TypeScript que puedes pegar directamente en tu proyecto.
Separar automáticamente objetos anidados en sus propias interfaces
Cuando tu JSON contiene otro objeto, este obtiene su propia interfaz con nombre basado en el campo, manteniendo todo ordenado.
Marcar campos como opcionales cuando los elementos de un array difieren
Cuando los objetos de un array no comparten todos los mismos campos, se combinan en una sola interfaz con '?' marcando los campos que no están en todos.
Prototipar tipos para la carga de GraphQL o de un webhook
Pega una carga de ejemplo como '{"event": "order.created", "data": {"id": "ord_1", "total": 42.5}}' para obtener rápidamente interfaces tipadas para un manejador de webhook, sin escribirlas a mano.
Comprobar cómo se tipan los valores null
Incluye un campo como '{"middleName": null}' en tu ejemplo para ver cómo representa la herramienta los campos que admiten nulos en la interfaz generada.
Referencia rápida
JSON values → TypeScript types
| JSON | TypeScript |
|---|---|
| "hello" | type Root = string; |
| 42 | type Root = number; |
| 3.14 | type Root = number; |
| true | type Root = boolean; |
| null | type Root = null; |
| [] | type Root = unknown[]; |
| [1, 2, 3] | type Root = number[]; |
| ["a", "b"] | type Root = string[]; |
| [1, "a", true] | type Root = (number | string | boolean)[]; |
| [1, null] | type Root = (number | null)[]; |
| [[1, 2], [3]] | type Root = number[][]; |
| {} | interface Root { } |
JSON objects → TypeScript interfaces
| JSON | TypeScript |
|---|---|
| {"id": 1, "name": "Ada"} | interface Root { id: number; name: string; } |
| {"deletedAt": null} | interface Root { deletedAt: null; } |
| {"tags": ["a", "b"]} | interface Root { tags: string[]; } |
| {"user": {"id": 1}} | interface User { id: number; } interface Root { user: User; } |
| {"items": [{"id": 1}, {"id": 2, "note": "x"}]} | interface Item { id: number; note?: string; } interface Root { items: Item[]; } |
| {"categories": [{"name": "x"}]} | interface Category { name: string; } interface Root { categories: Category[]; } |
| {"first-name": "Ada"} | interface Root { "first-name": string; } |
| {"a": {"x": 1}, "b": {"x": 2}} | interface A { x: number; } interface Root { a: A; b: A; } |
Preguntas frecuentes
¿Se envía mi JSON a un servidor?
No. Toda la conversión ocurre por completo en tu navegador, y lo que introduces nunca se envía a un servidor.
¿Puedo usar el código generado tal cual?
Se infiere a partir de un único ejemplo JSON, así que puede no capturar todas las variaciones posibles de tus datos reales. Trata la interfaz generada como un punto de partida y ajústala según necesites.
¿Reconoce las cadenas de fecha como tipo Date?
No. JSON no tiene un tipo de fecha dedicado, así que todas las cadenas se tratan como string. Si quieres tratarlo como fecha, ajusta el código generado manualmente.
¿Qué pasa si la misma forma de objeto aparece varias veces?
Los objetos con una estructura idéntica reutilizan una sola interfaz en lugar de generar duplicados.
¿Cómo se tipan los arreglos vacíos?
Como un arreglo vacío no da ninguna pista sobre el tipo de sus elementos, se tipa como 'unknown[]'. Añade al menos un elemento de ejemplo al arreglo si quieres un tipo de elemento más específico.
¿Qué tipo de TypeScript recibe un valor null?
Un campo cuyo valor de ejemplo es null se tipa como 'null'. Si sabes que el campo también puede contener otros tipos, como una cadena o estar ausente, tendrás que ampliar a mano el tipo generado, por ejemplo a 'string | null'.
¿El orden de los campos de mi JSON afecta a la interfaz generada?
No. Los campos se listan en la interfaz generada en el mismo orden en que aparecen en tu entrada, pero reordenarlos en el JSON de origen no tiene ningún efecto en los propios tipos generados.