Este exemplo mostra como gerar tipos TypeScript a partir de uma resposta típica de API REST. O JSON pré-preenchido representa um objeto de usuário com endereço aninhado, array de papéis e array de objetos de publicação.
O Que Você Obtém
A ferramenta produz:
- Uma interface
Rootcom todos os campos superiores tipados - Uma interface
RootAddresspara o objeto de endereço aninhado - Uma interface
RootPostsItempara cada publicação no array - Tipos corretos:
stringpara texto,numberpara IDs e contagens,booleanpara flags,string[]para arrays de strings
Como Usar
- O exemplo carrega com uma resposta de API de usuário de exemplo já preenchida
- Alterne entre os modos de saída Interface e Type para ver ambos os estilos
- Copie os tipos gerados e cole em seu projeto TypeScript
- Substitua os dados de exemplo com sua resposta de API real para gerar tipos para seu endpoint específico
Padrão do Mundo Real
A maioria das APIs REST retorna objetos com estruturas aninhadas e arrays. Este exemplo cobre o padrão comum: campos planos no nível superior, um objeto aninhado para dados relacionados e arrays para coleções. Os tipos gerados dão suporte completo ao IntelliSense ao trabalhar com respostas de API em TypeScript.