Como gerar código a partir de JSON

O que pode fazer com um JSON

O JSON to Code transforma texto JSON em código-fonte com uma estrutura baseada nos valores fornecidos. É útil quando tem um objeto JSON e quer obter uma base de tipos para continuar o trabalho em TypeScript ou Python, sem escrever manualmente cada campo.

A ferramenta suporta interfaces TypeScript e dataclasses Python. TypeScript é a opção predefinida, por isso pode começar por colar o JSON e só mudar a linguagem se precisar de Python. A estrutura gerada acompanha os objetos aninhados, o que ajuda a representar respostas com vários níveis.

Passos para gerar o código

1. Prepare um texto JSON válido. Use um objeto ou outra estrutura JSON bem formada e confirme que não ficou texto adicional fora do conteúdo. A entrada vazia ou composta apenas por espaços não produz código, e um JSON malformado também falha.

2. Cole o conteúdo no campo de entrada. Se estiver a partir de um exemplo de uma API, reveja aspas, chavetas, vírgulas e os valores booleanos antes de avançar. O conteúdo precisa de ser interpretado como JSON, não como texto livre.

3. Escolha a linguagem de saída. Se não alterar a opção inicial, a geração é feita em TypeScript. Também pode selecionar Python. Não escolha uma linguagem fora destas duas opções, porque esse valor não é suportado.

4. Se precisar de um nome de tipo de raiz específico, forneça-o no controlo próprio. Caso não indique um nome, a raiz usa o nome predefinido Root.

5. Inicie a geração e leia o código apresentado. Para um objeto JSON, procure declarações de interface quando escolher TypeScript ou declarações de dataclass quando escolher Python. Verifique os nomes dos campos e os tipos antes de os integrar no seu projeto.

Por exemplo, considere esta entrada: {"user":{"name":"Ana","active":true,"score":4}}. Ao escolher TypeScript e iniciar a geração, espere uma estrutura com uma interface para a raiz, um tipo aninhado para user, e campos equivalentes a string, boolean e number. Se escolher Python, a forma esperada passa por dataclasses, com str, bool e float para esses valores. Este cenário descreve o formato do resultado; não substitui a revisão do código no contexto da sua aplicação.

Como ler e validar o resultado

O resultado não é uma conversão de texto genérico: os tipos são inferidos a partir dos valores presentes no JSON. Uma cadeia de texto corresponde a string em TypeScript e a str em Python; um valor booleano corresponde a boolean e bool; um número corresponde a number e float. Os objetos dentro de outros objetos recebem tipos próprios, e os campos que os representam apontam para esses tipos.

Depois da geração, compare a saída com a forma de dados que pretende usar. Confirme, em especial, se o exemplo JSON inclui os campos relevantes e se a linguagem escolhida corresponde ao seu projeto. A ferramenta falha perante entrada vazia, JSON inválido ou uma linguagem não suportada, por isso esses casos devem ser corrigidos antes de interpretar a saída.

O código gerado deve ser revisto antes de ser incorporado numa aplicação. A inferência depende do JSON fornecido e não estabelece, por si só, regras adicionais do seu domínio, variações futuras da resposta ou requisitos específicos do projeto.

Exemplo prático

Está a preparar tipos para uma resposta JSON que contém um utilizador com nome, estado ativo e pontuação.

Cole {"user":{"name":"Ana","active":true,"score":4}}, mantenha TypeScript selecionado e inicie a geração. Em seguida, compare a forma produzida com a estrutura do JSON.

Para o objeto fornecido, a saída deve conter uma estrutura de raiz, um tipo aninhado para user e os tipos correspondentes a texto, booleano e número. Em TypeScript, esses tipos são string, boolean e number; em Python, str, bool e float.

Limitações

• A estrutura gerada depende do JSON fornecido e da forma dos seus valores. Reveja a saída para confirmar se representa as regras e as variações previstas no seu projeto.

Erros comuns

• Se a geração falhar, a causa pode ser uma entrada vazia, apenas com espaços, ou um JSON malformado. Cole um conteúdo JSON não vazio e reveja a sintaxe, incluindo aspas, chavetas e vírgulas.

Perguntas frequentes

Que linguagens posso escolher para o código gerado?

Pode escolher TypeScript ou Python. TypeScript gera interfaces e Python gera dataclasses.

Posso gerar código sem introduzir um JSON?

Não. Se a entrada estiver vazia ou contiver apenas espaços, a geração falha; forneça um JSON não vazio e válido.

Como altero o nome do tipo de raiz?

Se não fornecer um nome personalizado, a raiz usa Root. Quando indicar outro nome no controlo próprio, esse nome pode ser usado para a raiz gerada.