☰ Formatador de YAML

Como formatar YAML online

YAML (YAML Ain't Markup Language) é um padrão de serialização de dados criado para ser fácil de ler por humanos, tornando-se o formato de configuração preferido para infraestrutura e aplicações modernas. Ao contrário do JSON ou do XML, o YAML depende da indentação em vez de chavetas ou etiquetas para definir a estrutura, o que o torna limpo e legível, mas também sensível a inconsistências de espaçamento. O nosso formatador de YAML resolve isto aplicando uma indentação uniforme de dois espaços em todo o documento.

Começar é simples. Cole o seu conteúdo YAML no editor e clique no botão Formatar. A ferramenta analisa a estrutura do seu YAML, identifica todos os níveis aninhados de objetos e listas, e reconstrói o resultado com uma indentação perfeitamente alinhada. Este processo preserva todos os seus dados, garantindo que cada chave, valor e item de lista fica situado no nível de profundidade correto.

O formatador lida com todas as funcionalidades habituais do YAML: mapeamentos (pares chave-valor), sequências (listas com um travessão inicial), cadeias de texto entre aspas ou sem aspas, valores numéricos, booleanos como true e false, valores nulos e até cadeias de texto com várias linhas usando o indicador de barra vertical (|) e o indicador de dobra (>). Os comentários são preservados durante a formatação, para que nunca perca anotações importantes nos seus ficheiros de configuração.

Quer esteja a arrumar um manifesto Kubernetes desorganizado, a organizar um ficheiro Docker Compose ou a preparar um playbook Ansible para revisão de código, uma formatação consistente torna o seu YAML mais fácil de ler, comparar em diffs e manter ao longo do tempo. O formatador funciona inteiramente no seu navegador, para que os seus dados de configuração permaneçam privados e seguros no seu próprio dispositivo.

YAML versus JSON: entender as diferenças

YAML e JSON são ambos formatos populares de serialização de dados, mas servem propósitos e públicos ligeiramente diferentes. O JSON é amplamente usado para troca de dados entre serviços web e APIs graças à sua sintaxe rígida e ao suporte universal de analisadores. O YAML, por outro lado, foi concebido tendo a legibilidade humana como principal objetivo, o que o torna a escolha preferida para ficheiros de configuração em todo o ecossistema DevOps.

Uma das maiores diferenças está na sintaxe. O JSON exige chaves entre aspas duplas, chavetas para objetos e parênteses retos para listas. O YAML usa a indentação para representar a hierarquia, travessões para os itens de lista e dois pontos para os pares chave-valor. Isto significa que a mesma estrutura de dados frequentemente ocupa menos linhas e caracteres em YAML. Uma configuração de servidor simples que ocupa oito linhas em JSON pode precisar de apenas cinco linhas em YAML, sem chavetas nem vírgulas para gerir.

O YAML também suporta funcionalidades que o JSON não tem: comentários (com o símbolo #), cadeias de texto com várias linhas (com | para blocos literais ou > para blocos dobrados), além de âncoras e aliases para reutilizar dados dentro do mesmo documento. Estas funcionalidades tornam o YAML especialmente poderoso em cenários de configuração complexos, onde a documentação e o princípio DRY (Don't Repeat Yourself, não se repita) realmente importam.

No entanto, a dependência do YAML em relação aos espaços em branco pode ser uma faca de dois gumes. Um único espaço ou tabulação mal colocados podem quebrar o documento inteiro. É por isso que ferramentas como o nosso formatador e validador de YAML são essenciais: detetam erros de indentação antes de estes causarem falhas em tempo de execução nos seus pipelines de implementação. Os nossos botões de conversão permitem alternar livremente entre YAML e JSON, consoante o que o seu fluxo de trabalho atual exigir.

YAML em DevOps: Kubernetes, Docker Compose e CI/CD

O YAML tornou-se o padrão de facto para a configuração de infraestrutura no mundo DevOps. Praticamente todas as grandes plataformas e ferramentas do ecossistema nativo da nuvem usam YAML nos seus ficheiros de configuração. Compreender a formatação YAML não é apenas uma comodidade, é uma necessidade prática para engenheiros de software e profissionais de DevOps atualmente.

O Kubernetes usa YAML extensivamente para definir implementações, serviços, ConfigMaps, secrets, regras de ingress e dezenas de outros tipos de recursos. Um manifesto Kubernetes típico inclui estruturas aninhadas como spec.containers[].ports[] que precisam de estar indentadas com precisão. Basta um único espaço a mais para que o kubectl apply rejeite o ficheiro inteiro. O nosso formatador garante que os seus manifestos ficam devidamente estruturados antes de os enviar para o seu cluster.

Os ficheiros Docker Compose definem aplicações com vários contentores, incluindo serviços, redes, volumes e variáveis de ambiente. O formato docker-compose.yml exige um aninhamento cuidadoso das definições de serviço, mapeamentos de portas e declarações de dependências. Formatar estes ficheiros de forma consistente facilita a sua revisão em pull requests e reduz a probabilidade de erros na implementação.

Os fluxos de trabalho do GitHub Actions, os pipelines do GitLab CI, as configurações do CircleCI e outras plataformas de CI/CD dependem todos do YAML para definir etapas de build, gatilhos, matrizes de ambientes e fases de implementação. Estes ficheiros podem tornar-se complexos rapidamente, com expressões condicionais, estratégias de matriz e referências a workflows reutilizáveis. Um YAML devidamente formatado mantém estes pipelines legíveis e fáceis de manter à medida que os seus projetos crescem.

O nosso validador de YAML deteta erros comuns antes de estes chegarem ao seu pipeline de CI/CD: níveis de indentação incorretos, dois pontos em falta após chaves, tabulações misturadas com espaços e itens de lista mal formatados. Ao validar localmente no seu navegador, obtém feedback instantâneo sem esperar que um build falhado lhe diga que algo está errado.

Validação de YAML e erros comuns

A sintaxe do YAML, sensível a espaços em branco, é propensa a erros subtis que são difíceis de detetar a olho nu. O nosso validador de YAML analisa o seu documento e indica a localização precisa dos erros, ajudando-o a resolver os problemas rapidamente. Estes são os erros de YAML mais comuns e como evitá-los.

A indentação inconsistente é o erro de YAML mais frequente. O YAML exige espaços para a indentação (tabulações não são permitidas no YAML padrão), e cada nível de aninhamento deve usar o mesmo número de espaços. Misturar indentação de dois e quatro espaços dentro do mesmo bloco, ou usar tabulações por engano, causará falhas de análise. O nosso formatador uniformiza tudo automaticamente para uma indentação de dois espaços.

Dois pontos em falta ou a ausência de espaço depois dos dois pontos confundem muitos utilizadores. No YAML, um par chave-valor exige dois pontos seguidos de um espaço: key: value. Escrever key:value sem espaço depois dos dois pontos será interpretado de forma diferente ou causará um erro. Da mesma forma, esquecer os dois pontos por completo transforma um mapeamento numa simples cadeia de texto.

A formatação incorreta de listas é outro problema comum. Os itens de lista devem começar com um travessão seguido de um espaço (- item). O travessão deve estar no nível de indentação correto em relação à sua chave superior. Listas aninhadas requerem indentação adicional, e misturar estilos de lista dentro da mesma sequência causa erros de análise.

Caracteres especiais em cadeias de texto sem aspas podem causar comportamento inesperado. Caracteres como :, #, [, ], {, } e , têm um significado especial em YAML. Se os valores das suas cadeias de texto contiverem estes caracteres, coloque-os entre aspas simples ou duplas. O nosso validador identifica as linhas onde caracteres especiais podem estar a causar problemas de análise e indica o número exato da linha para facilitar a depuração.

Ao passar o seu YAML pelo validador antes da implementação, deteta estes problemas localmente e instantaneamente, poupando o tempo que de outra forma passaria a depurar implementações falhadas, configurações danificadas ou comportamento estranho da aplicação causado por dados mal formados.

Perguntas frequentes

Ferramentas relacionadas

🔒 100% Privado e Seguro

Todo o processamento de YAML acontece localmente no seu navegador. Os seus dados de configuração nunca são enviados para nenhum servidor. Seguro para secrets do Kubernetes, chaves de API e configurações de infraestrutura sensíveis.