Format Atlas

Guias

Escolha um formato de configuração

Confira primeiro os formatos aceitos pela ferramenta. Se houver opções, escolha uma que a equipe consiga validar e manter com segurança.

Qual formato você deve escolher?

Escolha conforme a função de cada arquivo no fluxo de trabalho.

  • APIs e troca de dados web → JSON
  • Configuração hierárquica legível → YAML
  • Configuração com chaves e valores → TOML
  • Ferramenta exige um formato → siga a especificação

Priorize o suporte das ferramentas

O formato depende do aplicativo, biblioteca, sistema de CI e hospedagem. Confira os formatos e versões de especificação aceitos.

Automatize a validação da sintaxe

JSON, YAML e TOML podem falhar por erros de sintaxe ou de tipo. Valide ao salvar ou no CI e não guarde credenciais em arquivos de configuração no repositório.

Formatos a considerar

JSON

Indicado para: APIs ou configurações que aceitam JSON

Menos indicado para: Configuração manual que exige comentários

YAML

Indicado para: Configuração hierárquica mantida por pessoas

Menos indicado para: Troca simples em que erros de recuo são um problema

TOML

Indicado para: Configuração organizada em chaves e valores

Menos indicado para: Ferramentas que exigem JSON ou YAML

Antes de exportar

  • Confira formato e versão aceitos pela ferramenta.
  • Não guarde credenciais nem chaves privadas no repositório.

Comparações relacionadas

JSON vs TOMLJSON é amplamente usado em APIs e troca de dados entre programas. TOML foi pensado para configurações de aplicativos editadas por pessoas, com chaves, valores, tabelas e listas legíveis.YAML vs TOMLYAML e TOML são formatos de texto usados em configurações editadas por pessoas. YAML aceita hierarquias flexíveis; TOML prioriza opções explícitas e legíveis com chaves e tabelas. Escolha conforme a ferramenta e a estrutura dos dados.JSON vs YAMLJSON é um formato de texto estrito muito usado em APIs e troca de dados entre programas. YAML oferece uma sintaxe adequada a configurações e dados estruturados editados por pessoas. Escolha conforme o ecossistema e o fluxo de trabalho.YAML vs XMLYAML e XML representam dados estruturados. YAML costuma ser prático em configurações mantidas por pessoas; XML é comum em integrações que dependem de elementos, atributos, schemas ou namespaces.

Guias

Escolher um formato de troca de dadosComece pela especificação do sistema receptor. Use JSON para dados estruturados de API, XML quando a integração exigir schema e CSV para uma tabela única.Escolher formatos de dados e configuração webConsidere JSON para troca entre sistemas, como APIs, YAML para configurações editadas por pessoas e XML para integrações existentes baseadas em schema.Onde guardar configurações e segredosSepare configurações comuns de credenciais e escolha onde armazená-las no desenvolvimento local, na CI e em produção, de acordo com quem precisa acessá-las.

Referências e especificações