JSON para TypeScript
Gere uma interface TypeScript a partir de um exemplo JSON.
Exemplos de uso
Esboçar rapidamente um tipo para uma resposta de API
Cole um exemplo de resposta JSON do seu servidor e obtenha um rascunho de interface TypeScript para colar direto no seu projeto.
Separar automaticamente objetos aninhados em suas próprias interfaces
Quando seu JSON contém outro objeto, ele ganha sua própria interface nomeada com base no campo, mantendo tudo organizado.
Marcar campos como opcionais quando os itens de um array diferem
Quando os objetos de um array não compartilham todos os mesmos campos, eles são combinados em uma única interface com '?' marcando os campos que não estão presentes em todos.
Prototipar tipos para um payload de GraphQL ou webhook
Cole um payload de exemplo como '{"event": "order.created", "data": {"id": "ord_1", "total": 42.5}}' para obter rapidamente interfaces tipadas para um handler de webhook, sem escrevê-las à mão.
Verificar como os valores null são tipados
Inclua no seu exemplo um campo como '{"middleName": null}' para ver como a ferramenta representa campos anuláveis na interface gerada.
Referência 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; } |
Perguntas frequentes
Meu JSON é enviado a um servidor?
Não. Toda a conversão acontece inteiramente no seu navegador, e o que você digita nunca é enviado a um servidor.
Posso usar o código gerado como está?
Ele é inferido a partir de um único exemplo JSON, então pode não capturar todas as variações possíveis dos seus dados reais. Trate a interface gerada como um ponto de partida e ajuste conforme necessário.
Ele reconhece strings de data como tipo Date?
Não. JSON não tem um tipo de data dedicado, então toda string é tratada como string. Se quiser tratar como data, ajuste o código gerado manualmente.
O que acontece se o mesmo formato de objeto aparecer várias vezes?
Objetos com estrutura idêntica reutilizam uma única interface em vez de gerar duplicatas.
Como arrays vazios são tipados?
Como um array vazio não dá pista sobre o tipo dos seus elementos, ele é tipado como 'unknown[]'. Adicione pelo menos um elemento de exemplo ao array se quiser um tipo de elemento mais específico.
Que tipo TypeScript um valor null recebe?
Um campo cujo valor de exemplo é null é tipado como 'null'. Se você sabe que o campo também pode conter outros tipos, como uma string, ou estar ausente, será preciso ampliar manualmente o tipo gerado, por exemplo para 'string | null'.
A ordem dos campos no meu JSON afeta a interface gerada?
Não. Os campos são listados na interface gerada na mesma ordem em que aparecem na sua entrada, mas reordená-los no JSON de origem não tem efeito sobre os próprios tipos gerados.