Format Atlas

Guias

Escolher formatos de dados e configuração web

Considere JSON para troca entre sistemas, como APIs, YAML para configurações editadas por pessoas e XML para integrações existentes baseadas em schema.

Qual formato você deve escolher?

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

  • APIs web → JSON
  • Ajustes editados por pessoas → YAML
  • Schema ou contrato existente → XML

Use o formato exigido pelo receptor

Os três representam dados estruturados, mas diferem em sintaxe, comentários, interpretação de tipos e uso de schemas. Confira contrato e ferramentas primeiro.

Formatos a considerar

JSON

Indicado para: APIs e troca baseada em JSON

Menos indicado para: Ajustes manuais que exigem comentários

YAML

Indicado para: Configuração mantida por pessoas

Menos indicado para: APIs que aceitam só JSON

XML

Indicado para: Schemas e integrações XML existentes

Menos indicado para: APIs novas e simples sem requisitos XML

Antes de exportar

  • Não presuma que YAML seja um superconjunto estrito de JSON.
  • Confirme codificação, tipos e tratamento de schemas com o receptor.

Comparações relacionadas

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.XML vs JSONXML e JSON são formatos de texto para dados estruturados, mas usam estruturas e convenções diferentes.

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.

Referências e especificações