Format Atlas

Guides

Choosing Web Data and Configuration Formats

Consider JSON for machine exchange such as APIs, YAML for configuration people edit, and XML for existing schema-based integrations.

Which format should you choose?

Choose by the role each file plays in your workflow.

  • Web APIs → JSON
  • Human-edited settings → YAML
  • Existing schema or contract → XML

Use the format the recipient requires

All three represent structured data, but their syntax, comments, type interpretation, and schema workflows differ. Check the contract and tools first.

Formats to consider

JSON

Good for: APIs and JSON-based exchange

Less suitable for: Hand-edited settings requiring comments

YAML

Good for: Configuration maintained by people

Less suitable for: APIs accepting only JSON

XML

Good for: Existing XML schemas and integrations

Less suitable for: New simple APIs without XML requirements

Before you export

  • Do not assume YAML is a strict superset of JSON.
  • Confirm encoding, types, and schema handling with the recipient.

Related comparisons

JSON vs YAMLJSON is a strict text format widely used for APIs and data exchange between programs. YAML offers syntax suited to human-edited configuration and structured data. Choose for the ecosystem and workflow.XML vs JSONXML and JSON are text formats for structured data, but use different structures and conventions.

Guides

Choosing a Data Exchange FormatStart with the receiving system's specification. Use JSON for structured API data, XML where an integration requires its schema, and CSV for a single table.

References and specifications