Format Atlas

Comparar

JSON vs YAML

JSON é 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.

Qual formato você deve escolher?

Use JSON para cargas de API interoperáveis e troca entre programas. Considere YAML para configurações que se beneficiam de comentários e hierarquia concisa, validando com o parser de destino.

Indicado para JSON

APIs web, arquivos de configuração e troca de dados

  • Transferir dados estruturados

Indicado para YAML

Arquivos de configuração e dados estruturados

  • Configurações mantidas por pessoas

Informações básicas

CampoJSONYAML
Extensão.json.yaml, .yml
Tipo MIMEapplication/jsonapplication/yaml
Usos comunsAPIs web, arquivos de configuração e troca de dadosArquivos de configuração e dados estruturados
Como abrirAbra em um editor de texto, IDE ou visualizador compatível com JSON.Abra em um editor de texto ou ferramenta YAML e preserve a indentação com espaços.
Exportar ou converterAplicativos ou ferramentas de conversão podem convertê-lo para formatos como CSV.Se o destinatário exigir JSON, converta e verifique tipos e codificação de caracteres.

Escolha por finalidade

Transferir dados estruturados

APIs web, arquivos de configuração e troca de dados

JSON

Configurações mantidas por pessoas

Arquivos de configuração e dados estruturados

YAML

Ponto principal 1

JSON usa sintaxe explícita para objetos e listas e é padronizado para intercâmbio de dados.

Mais sobre as diferenças

Ponto principal 2

YAML aceita comentários e representações flexíveis e legíveis, comuns em arquivos de configuração.

Mais sobre as diferenças

Mais sobre as diferenças

Escolha o formato aceito de modo consistente pelas ferramentas. Valide os dados, evite construções YAML ambíguas e use análise segura para entradas não confiáveis.

  • A sintaxe mais estrita de JSON pode tornar previsíveis geração e análise entre ambientes.
  • YAML pode ser mais fácil de editar, mas a indentação e as regras do parser precisam ser consistentes.
  • Os dois exigem validação de esquema quando campos e tipos são importantes para o aplicativo.
  • Não trate YAML como um superconjunto estrito de JSON. Use o formato exigido pela interface e teste o comportamento do parser, pois implementações de YAML podem interpretar alguns valores simples de modos diferentes.

Perguntas frequentes

YAML é sempre mais fácil que JSON?

Não para todas as equipes ou ferramentas. YAML costuma ser conveniente para configurações editadas à mão; JSON é comum em APIs e intercâmbio estrito entre máquinas.

YAML é sempre melhor para configuração?

Não. YAML pode ser legível para pessoas, mas JSON pode ser melhor quando uma ferramenta exige JSON ou quando uma interpretação consistente é importante.

Saiba mais

Usos e verificações relacionados

Escolha um formato de configuraçãoEscolher formatos de dados e configuração web

Referências e especificações