Question 1

Quando devo usar YAML em vez de JSON?

Accepted Answer

YAML é a escolha certa quando humanos vão ler ou editar o arquivo diretamente. Manifestos Kubernetes, arquivos Docker Compose, workflows GitHub Actions e playbooks Ansible todos usam YAML porque a sintaxe baseada em indentação é visualmente menos poluída que chaves e aspas JSON, e YAML suporta comentários para documentar campos inline. JSON é a escolha certa para comúnicação máquina a máquina: respostas de API, package.json, tsconfig.json e qualquer config que ferramentas geram e leem programaticamente.

Question 2

YAML suporta comentários e eles sobrevivem à conversão de ida e volta?

Accepted Answer

YAML suporta comentários com o caractere #. No entanto, comentários não sobrevivem à conversão de JSON para YAML porque JSON não tem sintaxe de comentários. Comentários também não sobrevivem à conversão de YAML para JSON. Se você precisa de comentários no seu YAML, adicione-os manualmente após a conversão. O mesmo se aplica a anchors e aliases: eles são resolvidos para sua forma expandida pela maioria dos parsers YAML.

Question 3

JSON e YAML são intercambiáveis?

Accepted Answer

JSON é um subconjunto estrito de YAML 1.2, o que significa que qualquer documento JSON válido também é YAML válido. Na prática, converter de JSON para YAML é sempre seguro. O inversó (YAML para JSON) tem limitações: YAML suporta comentários, anchors, aliases, fluxos de múltiplos documentos e valores tipados como datas e binários que não têm equivalente JSON. Para intercâmbio de dados entre serviços, prefira JSON. Use YAML apenas para arquivos de configuração mantidos por humanos.

Question 4

Quais são as regras de indentação YAML e erros comuns?

Accepted Answer

YAML usa espaços para indentação, nunca tabs. Um caractere de tabulação em um arquivo YAML é um erro de sintaxe. O número de espaços por nível é flexível mas deve ser consistente dentro de um bloco. Dois espaços por nível é a convenção mais comum. Um erro comum é misturar indentação de dois e quatro espaços. Outro é o problema da Noruega: strings não entre aspas como NO, FALSE, YES, TRUE, ON, OFF são interpretadas como booleanos no YAML 1.1.

JSON	YAML
`{ "key": "value" }`	`key: value`
`{ "key": 42 }`	`key: 42`
`{ "key": true }`	`key: true`
`{ "key": null }`	`key: null`
`["a", "b"]`	`- a\n- b`
Objeto aninhado	Bloco indentado

Conversor de JSON para YAML: Transformador Online

A Saída YAML

Como JSON Mapeia para YAML

Quando Usar YAML

Kubernetes e Helm

Docker Compose

GitHub Actions

Ansible

Quando Usar JSON

Pegadinhas do YAML

O Problema da Noruega

Indentação com Tabs

Strings Multilinha