Ir para o conteúdo
snowkitDev

Gere interfaces TypeScript a partir de JSON, direto no navegador

Cole uma resposta de API ou qualquer amostra de JSON e obtenha interfaces TypeScript que combinam com o formato dela.

JSON para tipos

Cole o JSON e escolha a linguagem de que precisa.

Baixar

Os arrays são mesclados, então campos ausentes em alguns itens viram opcionais.

Objetos aninhados viram tipos nomeados, e campos ausentes em alguns itens viram opcionais. Cole uma amostra de JSON e obtenha tipos prontos para usar em TypeScript, Zod, Go, Python ou JSON Schema. Roda no seu navegador e é grátis e privado.

Como converter JSON em tipos

  1. Cole seu JSON em JSON ou toque em Experimente um exemplo.
  2. Escolha a saída: TypeScript, Zod, Go, Python ou JSON Schema.
  3. Leia o código gerado.
  4. Toque em Copiar código ou Baixar.

O que esta ferramenta faz

Ele lê o seu JSON, descobre o tipo de cada valor e escreve código que descreve esse formato. Arrays de objetos são mesclados, então um campo que aparece só em alguns itens é marcado como opcional, e um campo que às vezes é número e às vezes texto vira uma união.

Cinco saídas

Interfaces TypeScript para código de front-end e Node. Esquemas Zod que validam dados em tempo de execução e dão o tipo de graça. Structs Go com tags json, usando ponteiros para campos opcionais. Dataclasses Python com type hints modernos. JSON Schema (draft 2020-12) para validadores e documentação de API.

Dicas para tipos melhores

  • Use uma amostra com vários itens em cada array para os campos opcionais serem identificados.
  • Inclua valores para campos que às vezes ficam vazios, para o tipo não ficar estreito demais.
  • Renomeie o tipo raiz gerado para algo significativo para o seu projeto.
  • Use a saída como ponto de partida e depois ajuste à mão, por exemplo transformando campos de texto em valores permitidos específicos.
  • Confira antes se o seu JSON é válido com as ferramentas JSON.

Quem usa

Desenvolvedores que trabalham com uma API nova, estudantes que aprendem como os dados são organizados e freelancers que conectam o sistema de um cliente a um site. Para descrever uma ferramenta para um modelo de IA, use o criador de esquema de funções.

Privacidade

Respostas de API costumam conter dados reais de usuários. Aqui elas nunca saem do seu navegador: os tipos são gerados neste dispositivo.

Perguntas

Como as datas são tratadas?

Strings que parecem datas ISO viram time.Time em Go e recebem uma verificação de data em Zod e JSON Schema. Outras linguagens as mantêm como strings.

E se meu exemplo estiver incompleto?

Os tipos só podem descrever os dados que enxergam. Cole uma resposta com o máximo de campos preenchidos possível, ou vários itens em uma lista, para o resultado mais preciso.

O que acontece com valores nulos?

Um campo que às vezes é nulo vira uma união com null, ou um campo opcional, dependendo da linguagem.

Para onde ir agora

Continue com o que você acabou de criar, ainda no seu dispositivo.

Mais do Snowkit