O que é YAML
YAML é um formato de texto para descrever configuração e informação estruturada. Ele usa indentação, listas e pares de chave e valor, e aceita comentários.
O formato aparece no arquivo do Docker Compose, no pipeline e no frontmatter de um documento. A leitura precisa ser exata, porque o espaçamento faz parte da estrutura.
Indentação e estrutura
A indentação define a hierarquia. Um nível a mais cria um filho, e um nível a menos encerra o bloco anterior.
As listas usam um traço, e os pares usam dois-pontos. O texto com dois-pontos seguido de espaço precisa de aspas para não ser lido como um novo campo.
O que costuma quebrar
O tab no lugar do espaço, a chave repetida e o valor sem aspas são os erros mais comuns. O YAML também interpreta algumas palavras como verdadeiro ou falso.
O validador da ferramenta aponta a linha. O schema confirma o campo esperado, e a correção precisa preservar a estrutura do restante do arquivo.
Exemplo
Como conferir
Valide o arquivo com a ferramenta e leia a mensagem do schema. Confira a indentação, as aspas e as chaves repetidas, e compare o resultado com o ambiente que funciona.
A configuração precisa ficar versionada, e o schema define o que é aceito. O build confirma se o arquivo foi lido como esperado.
Dúvidas frequentes
Perguntas frequentes sobre YAML
- YAML é a mesma coisa que JSON?
- Os dois descrevem informação estruturada. O YAML usa indentação e aceita comentários, e o JSON usa chaves e aspas. O YAML pode ser convertido para JSON.
- Tab funciona como indentação?
- Não. O YAML usa espaços, e o tab costuma causar erro de leitura. A configuração do editor precisa substituir o tab por espaços.
- Por que um valor virou booleano?
- Algumas palavras são interpretadas como verdadeiro ou falso. O valor precisa de aspas quando o texto deve permanecer texto.
- Como validar o arquivo?
- Use o validador da ferramenta e confira o schema. A mensagem indica a linha e o campo, e a leitura do trecho confirma a indentação.
Para continuar
Recursos relacionados
Documentação
YAML 1.2: especificação
Define a sintaxe, a indentação e os tipos do formato.
Abrir recursoSite de referência
Wikipedia: YAML
Apresenta a origem e as características do formato.
Abrir recursoAplicação na formação
Developer Workspace
No Developer Workspace, o YAML aparece no arquivo do Compose e na configuração do pipeline.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.