JSON a YAML: tornando a saída da máquina legível novamente

Por que converter JSON em YAML

Os dois formatos contêm dados idênticos, mas são otimizados para leitores diferentes. JSON gasta caracteres entre colchetes, vírgulas e aspas; YAML gasta-os na estrutura que o olho pode seguir como recuo. Para dados gerados e consumidos por programas, JSON vence. Para dados que uma pessoa edita — Helm valores, definições de CI, inventários Ansible, Docker arquivos de composição — YAML ganha, e é por isso que essa direção surge sempre que os dados gerados precisam de um proprietário humano.

Comentários são a única coisa que não pode sobreviver

A conversão pode restaurar a legibilidade, mas não pode restaurar a intenção: a fonte JSON não tinha comentários para transferir. Se o YAML gerado for mantido por pessoas, adicione um pequeno comentário no cabeçalho descrevendo de onde ele veio e o que o regenera, para que ninguém edite um arquivo que será sobrescrito na próxima implantação.

Citando: onde convertido YAML quebra silenciosamente

YAML trata diversas palavras simples como valores em vez de strings. Um conversor que descarta aspas agressivamente pode alterar os tipos sem alterar um único caractere visível:

                country: NO        # parses as boolean false in YAML 1.1
version: 1.10      # parses as the number 1.1
time: 22:30        # parses as a sexagesimal integer
name: "on"         # quoted on purpose — must stay a string
              

Uma boa saída cita qualquer string que possa ser mal interpretada — `yes`/`no`/`on`/`off`, identificadores de aparência numérica, valores com zeros à esquerda, horas e datas — em vez de citar tudo, o que produz a parede de pontuação da qual você estava tentando escapar.

Recuo e strings multilinhas

Dois espaços é o padrão seguro: é o que a documentação Kubernetes, os modelos Helm e a maioria dos editores assumem, e sobrevive ao copiar e colar entre as ferramentas. O aninhamento profundo no estilo de quatro espaços é difícil de digitalizar além de seis níveis. Strings longas são a outra decisão de formatação — um valor JSON com novas linhas incorporadas pode sair como uma linha de escape ou como um escalar de bloco YAML que lê naturalmente. Se o campo for um script de shell ou um snippet de configuração, solicite o formulário de bloco.

A classificação de chaves torna as diferenças significativas

A ordem da chave do objeto JSON não é significativa, então os conversores são livres para reordenar. A classificação das chaves em ordem alfabética faz com que os arquivos regenerados sejam diferenciados de maneira limpa: sem isso, uma ordem de implantação alterada aparece como uma reescrita de arquivo inteiro. Se você estiver rastreando YAML gerado no git, a classificação é a diferença entre uma diferença de uma linha e uma de duzentas linhas.

Mantenha a viagem de ida e volta em um só lugar

Como as duas direções são inversas, vale a pena ter ambas na mesma ferramenta para que você possa converter, editar e converter novamente sem mudar de contexto ou colar sua configuração em três serviços diferentes. O conversor baseado em navegador neste site emparelha com a ferramenta YAML para JSON, funciona offline e nunca carrega a carga útil – o que é importante quando o JSON em questão é uma resposta de produção API.