Como converter YAML para JSON passo a passo

Para que serve a conversão de YAML para JSON

Este conversor transforma texto em formato YAML em texto JSON, o que é útil quando precisa de passar uma configuração para uma ferramenta que espera JSON ou de verificar a estrutura dos dados num formato diferente. O resultado é gerado a partir dos valores interpretados no texto de entrada, e não como uma cópia visual do conteúdo original.

Pode utilizá-lo com objetos simples, objetos aninhados e listas. Também pode escolher o nível de indentação do JSON e ativar a ordenação das chaves quando pretende uma apresentação mais consistente para leitura ou comparação. A indentação predefinida é de 2 espaços e a ordenação das chaves começa desativada.

Como converter o texto passo a passo

Prepare o texto de entrada em formato YAML. Inclua os objetos, os níveis aninhados ou as listas que pretende converter. Reveja a indentação e a sintaxe antes de continuar.
Cole o conteúdo no campo de entrada do conversor. Se deixar o campo vazio ou introduzir apenas espaços, a operação é considerada bem-sucedida e o resultado será um objeto JSON vazio.
Ajuste a indentação do JSON se necessário. Mantenha a predefinição para uma saída compacta, mas legível, ou escolha outra configuração disponível para controlar o espaçamento visual.
Decida se quer ordenar as chaves dos objetos. Ative essa opção apenas quando a ordem alfabética das chaves ajudar a consultar ou comparar o resultado; por predefinição, a ordenação está desativada.
Inicie a conversão e examine o texto JSON produzido. Se a operação não for bem-sucedida, volte ao texto de entrada e procure problemas de sintaxe, como níveis desalinhados, separadores incorretos ou valores que não possam ser representados em JSON.
Para um texto com vários documentos separados pela marca de início e por outra separação de documento, confirme como o resultado foi agrupado. Documentos nulos são removidos; se restar mais do que um documento válido, o resultado é uma lista JSON. Se restar apenas um, é devolvido esse documento, e se não restar nenhum, é devolvido um objeto vazio.

Como ler e validar o resultado

Um resultado bem-sucedido é texto JSON, não o texto de configuração original. Objetos simples continuam a ser objetos, estruturas aninhadas mantêm a sua relação hierárquica e sequências passam a ser listas JSON. A indentação altera a apresentação do texto; a ordenação, quando ativada, altera a ordem das chaves dos objetos na saída.

Considere um ficheiro de configuração com um objeto principal, uma secção aninhada e uma lista de opções. Cole esse conteúdo, conserve a indentação predefinida e deixe a ordenação desativada. O resultado esperado tem a forma de um objeto JSON com uma propriedade para a secção aninhada e uma lista JSON para as opções. Se enviar vários documentos válidos, o resultado esperado tem a forma de uma lista JSON; com um único documento não nulo, tem a forma desse documento.

A conversão falha quando o texto não é YAML válido ou quando o valor interpretado não pode ser serializado como JSON. Nesses casos, não trate uma saída inexistente ou malsucedida como se fosse um JSON parcial. Corrija a entrada e repita a operação. Tenha também presente que comentários, aspas originais e a disposição visual do texto não são apresentados como elementos preservados do formato de origem: o conteúdo é interpretado e depois emitido como JSON.

Exemplo prático

Está a adaptar uma configuração com parâmetros agrupados e várias opções para uma ferramenta que aceita JSON.

Cole o texto de configuração com um objeto principal, uma secção aninhada e uma lista, mantenha a indentação predefinida e execute a conversão sem ativar a ordenação das chaves.

O resultado tem a forma de um objeto JSON com uma propriedade aninhada e uma lista JSON correspondente às opções fornecidas.

Limitações

A conversão não é bem-sucedida com YAML malformado ou quando o valor interpretado não pode ser serializado como JSON.
O resultado é texto JSON gerado a partir dos valores interpretados, pelo que não deve ser tratado como preservação da apresentação original do texto de entrada.

Erros comuns

Uma causa frequente de falha é uma estrutura YAML malformada, por exemplo, uma indentação inconsistente. Corrija o alinhamento e os separadores do texto de entrada e execute novamente a conversão.

Perguntas frequentes

Posso converter listas e estruturas aninhadas?

Sim. O conversor aceita objetos, objetos aninhados e sequências, convertendo os valores interpretados para a representação JSON correspondente.

Como são tratados vários documentos no mesmo texto?

Sim, mas o comportamento depende do conteúdo. Com vários documentos não nulos, o resultado é uma lista JSON; com apenas um documento não nulo, é devolvido esse documento. Documentos nulos são removidos.

O conversor produz JSON mesmo com YAML inválido?

Não. Quando o texto está malformado, a conversão não é bem-sucedida. Reveja a sintaxe e a indentação antes de tentar novamente.