Um formatador JSON e um validador JSON estão relacionados, mas não resolvem o mesmo problema. A formatação torna o JSON mais fácil de ler. A validação verifica se o JSON pode ser analisado. Antes de colar um snippet em documentos, um campo de configuração, um problema ou uma resposta de suporte, pode precisar de um ou de ambos.
O Conversor JSON/YAML/TOML do Converty mantém estes trabalhos juntos: valide a entrada, formate-a para revisão, reduza-a quando a saída compacta for importante e converta-a quando o próximo sistema esperar YAML ou TOML.
Utilize um formatador quando o JSON for difícil de ler
A formatação tem a ver com a apresentação. Adiciona recuo e quebras de linha para que a estrutura seja mais fácil de inspecionar.
Utilize a formatação quando:
- uma carga útil é reduzida numa linha
- os objetos aninhados são difíceis de seguir
- um exemplo de API necessita de ser mostrado na documentação
- os revisores precisam de comparar os campos rapidamente
- uma resposta de suporte precisa de um excerto legível
A formatação não prova que o exemplo esteja semanticamente correto. Simplesmente torna a estrutura visível.
Utilizar um validador quando o JSON é inválido
A validação tem a ver com a capacidade de análise. Deteta problemas de sintaxe, como vírgulas em falta, strings não fechadas, aspas inválidas ou aninhamento quebrado.
Utilize a validação antes de colar JSON num sistema que rejeitará entradas inválidas. Também é útil antes de partilhar exemplos porque os excertos inválidos desperdiçam o tempo do revisor e tornam a documentação menos fiável.
Utilize ambos antes de partilhar exemplos importantes
O fluxo de trabalho mais seguro é a validação primeiro e a formatação depois. Se o JSON não for analisado, corrija isso antes de se preocupar com a apresentação. Assim que for válido, formate-o para que os humanos o possam ler.
Esta sequência é especialmente útil para exemplos de API. Para um fluxo de trabalho focado na partilha de API, leia Como formatar JSON antes de partilhar um exemplo de API.
Quando a conversão entra em cena
Por vezes, o sistema seguinte precisa de YAML ou TOML em vez de JSON. A conversão é uma terceira tarefa, separada da formatação e validação. Altera a sintaxe ao tentar preservar a estrutura de dados.
Nem toda a estrutura está mapeada de forma clara para todos os formatos, e é por isso que os avisos de compatibilidade são importantes. Se a saída TOML não estiver disponível, leia Porque é que a saída TOML não está disponível para algumas entradas JSON ou YAML.
Abra o Conversor JSON/YAML/TOML quando necessitar de validar, formatar, reduzir ou converter dados estruturados antes de os colar no próximo fluxo de trabalho.
