Transforme uma resposta de exemplo em tipos
Quase todo trabalho com APIs começa igual: você tem uma resposta em JSON e precisa de um tipo para ela. Cole a resposta à esquerda e o lado direito mostra o TypeScript correspondente, pronto para um arquivo .ts. Nada precisa ser digitado à mão, e um payload com dez níveis de aninhamento leva o mesmo tempo que um com dois.
Do payload ao arquivo de declaração
- Cole o JSON na caixa da esquerda ou clique em Exemplo para ver como funciona.
- Defina o nome do tipo principal, por exemplo
UserouApiResponse. - Escolha entre
interfaceetypee marque export ou somente leitura, se quiser. - Confira o resultado à direita. Um erro de sintaxe é informado no lugar dos tipos.
- Use Copiar ou Baixar .ts para levar o código.
Como os tipos são deduzidos
- Strings, números, booleanos e null correspondem ao tipo TypeScript equivalente.
- Um objeto aninhado vira uma interface própria, nomeada pela chave em PascalCase. A chave
shipping_addressgeraShippingAddress. - Em arrays, todos os elementos são mesclados. Uma chave que aparece só em alguns deles é marcada como opcional com um ponto de interrogação, e valores de tipos diferentes viram uma união como
string | number. - Dois objetos com exatamente o mesmo formato compartilham uma interface em vez de gerar duas cópias.
- Um array vazio gera
unknown[]e um objeto vazio geraRecord<string, unknown>.
Limites de deduzir a partir de um único exemplo
Um exemplo só mostra o que contém. Um campo que sempre veio preenchido no seu exemplo pode ser null em produção, e um número que parece um id pode ser uma string em outro lugar. Datas chegam como strings, por isso são tipadas como string. Trate a saída como um primeiro rascunho e refine à mão, ou valide as respostas reais em tempo de execução, se os dados vierem de fora do seu controle.
Seu payload continua privado
A conversão roda na própria página. Respostas de produção, tokens e dados pessoais num exemplo colado não são enviados a nenhum servidor, o que torna seguro usar com dados reais.