JSON Formatter (ferramenta de formatação JSON)

O que é o JSON Formatter?

O JSON Formatter é uma ferramenta concebida para reformatar JSON de linha única de difícil leitura ou JSON com indentação incorreta para um formato mais legível. O JSON é utilizado em diversos contextos, tais como respostas de API, configurações de serviços web, troca de dados em aplicações JavaScript, registos e consultas a bases de dados NoSQL. No entanto, o JSON que recebe frequentemente carece de quebras de linha e estende-se por várias linhas horizontalmente, tornando difícil acompanhar o conteúdo a olho nu. Quando cola JSON nesta ferramenta, esta adiciona quebras de linha e indentação para tornar as chaves, valores, matrizes e estruturas aninhadas mais fáceis de ler.

Para além da formatação, suporta compressão para remover espaços e quebras de linha em excesso, bem como verificação de sintaxe para garantir que o JSON é válido. Pode utilizá-lo quando pretender verificar respostas de API durante o desenvolvimento, confirmar que não existem erros após a edição de ficheiros de configuração ou tornar o texto mais fácil de ler antes de o colar em conversas ou documentação. O resultado pode ser copiado e descarregado como um ficheiro JSON, se necessário.

Esta página é processada utilizando JavaScript no navegador. Não há envio de formulário para o servidor para formatar o JSON introduzido. No entanto, ao lidar com JSON que contenha informações confidenciais, dados pessoais, tokens de autenticação, chaves privadas ou dados sensíveis semelhantes, tenha cuidado ao utilizá-lo em dispositivos partilhados, extensões de navegador, partilha de ecrã e histórico do navegador. Para garantir o tratamento seguro do conteúdo JSON, recomendamos a remoção de qualquer informação desnecessária antes de o formatar.

• Pode formatar JSON utilizando espaços duplos, espaços quádruplos ou tabulações para recuo.
• Pode comprimir o JSON numa única linha e convertê-lo num formato adequado para transmissão e armazenamento.
• Pode utilizar o JSON.parse para verificar se faltam vírgulas ou se há aspas incorretas.
• Pode copiar os resultados formatados para a área de transferência ou guardá-los como formatted.json.

Como utilizar o JSON Formatter

É fácil de usar. Primeiro, cole o JSON que pretende formatar no campo «JSON Input». Pode introduzir JSON diretamente a partir de fontes como clientes API, ferramentas de desenvolvimento do navegador, registos ou ficheiros de configuração. Em seguida, selecione o estilo de indentação que pretende para o resultado. Embora sejam normalmente utilizados dois espaços, pode optar por quatro espaços para uma melhor legibilidade ou por tabulações para se adequar às convenções do seu projeto existente.

Clicar em «Formatar» apresenta o resultado com quebras de linha e indentação após a análise do JSON. Clicar em «Comprimir» apresenta uma única linha de JSON com espaços em branco e quebras de linha removidos. A «Verificação de sintaxe» é útil quando pretende apenas verificar se a sua entrada é JSON válido antes de gerar a saída. Se houver erros, será exibida uma mensagem com base nos resultados da análise do navegador. Embora a forma como os erros são exibidos possa variar consoante o navegador, as causas mais comuns são vírgulas finais, aspas simples em falta, aspas em falta em torno dos nomes das chaves e parênteses de fecho em falta.

1. Cole o JSON que pretende formatar no campo «Entrada JSON».
2. Escolha entre 2 espaços, 4 espaços ou uma tabulação para recuo, conforme necessário.
3. Para facilitar a leitura do texto, clique em «Formatar»; para condensá-lo numa única linha, clique em «Comprimir»; para verificar a sua exatidão, clique em «Verificação de sintaxe».
4. Analise os resultados e cole-os na sua aplicação utilizando «Copiar resultados» ou «Descarregar JSON».

Notas importantes ao utilizar

• Em JSON, as chaves e as cadeias de caracteres devem ser colocadas entre aspas duplas. Embora isto seja semelhante à notação de objetos em JavaScript, não é a mesma coisa.
• Não são permitidas vírgulas no final das linhas em JSON. Se houver uma vírgula após o último elemento de uma matriz ou objeto, isso causará um erro.
• Colar ficheiros JSON excessivamente grandes pode fazer com que o seu navegador fique lento. No caso de ficheiros muito grandes, considere utilizar um editor dedicado para os rever.
• Tenha o cuidado de não manusear ficheiros JSON que contenham tokens de autenticação, chaves API ou informações pessoais em ambientes partilhados ou durante a partilha de ecrã.

Perguntas frequentes

O que é um formatador JSON?

O JSON Formatter é uma ferramenta que formata cadeias JSON num formato legível. Adiciona quebras de linha e indentação para facilitar a visualização da estrutura de objetos, matrizes, cadeias, números, valores booleanos, valores nulos e muito mais.

Qual é a diferença entre formatação JSON e compressão?

A formatação envolve a adição de quebras de linha e recuos para facilitar a leitura do texto. A compressão remove espaços em branco e quebras de linha desnecessárias para criar um formato JSON curto, de uma única linha, adequado para guardar ou enviar.

Pode verificar se o JSON está correto?

Sim. Pode utilizar o botão «Verificação de sintaxe» para verificar se a sua entrada pode ser analisada como JSON. Se estiver correta, será apresentada como JSON válido; se houver erros, será apresentada uma mensagem de erro.

O JSON introduzido é enviado para o servidor?

A formatação, compressão e verificação de sintaxe desta ferramenta são realizadas no navegador. Em condições normais de funcionamento, não existe nenhum processo que envie um formulário ao servidor para formatar JSON.

É possível usar aspas simples no JSON?

Em JSON, as cadeias de caracteres e os nomes das chaves devem ser colocados entre aspas duplas. A notação ao estilo JavaScript, que utiliza aspas simples, não é válida em JSON.

Uma vírgula final causará um erro?

Sim. Em JSON, não é possível colocar uma vírgula após o último elemento de uma matriz ou objeto. Embora isso seja por vezes permitido em JavaScript, constitui um erro em JSON.

O que é recomendado: dois espaços ou quatro espaços?

Geralmente, são utilizados dois espaços. Se pretender aumentar o espaçamento para melhorar a legibilidade, utilize quatro espaços; se o seu projeto tiver diretrizes específicas, siga essas diretrizes.

Pode ser utilizado com ficheiros JSON de grande dimensão?

Pode utilizá-lo desde que se enquadre nas capacidades do navegador. No entanto, com ficheiros JSON muito grandes, a colagem e a formatação podem demorar algum tempo e fazer com que o navegador fique lento.

Qual é a diferença entre objetos JSON e JavaScript?

O JSON é um formato baseado em texto para a troca de dados. Tem regras mais rigorosas do que os literais de objeto do JavaScript, como a exigência de aspas duplas para nomes de chaves e cadeias de caracteres. Não é possível incluir comentários.

É possível formatar JSON com comentários?

Não são permitidos comentários no JSON padrão. Por conseguinte, texto no estilo JSON que contenha comentários como // ou /* */ resultará num erro. Formatos como o JSONC não são suportados.

Posso guardar os resultados?

Sim. Pode copiar os resultados formatados ou compactados. Também pode guardá-los como formatted.json clicando no botão «Descarregar JSON».

Isto também pode ser usado para verificar respostas da API?

Sim. Colar a resposta JSON obtida da API facilita a verificação de estruturas aninhadas e do conteúdo de matrizes. Isto é útil durante o desenvolvimento, os testes e a depuração.