Format Atlas

PRACTICAL GUIDE

Webデータ・設定ファイルの選び方

APIなど機械的な交換ではJSON、手で保守する設定ではYAML、既存のschema連携ではXMLを候補にします。

最終確認: 2026-09-21

迷ったら、ここで選ぶ

  • Web API → JSON
  • 人が編集する設定 → YAML
  • 既存schema・連携仕様 → XML

相手が求める形式を優先する

JSON、YAML、XMLはいずれも構造化データを扱えますが、構文、コメント、型解釈、schemaの運用が異なります。相手の仕様とツール対応を先に確認します。

候補形式

JSON

向く場面:Web APIやJSON前提のデータ交換

向かない場面:コメントを含む手作業の設定

YAML

向く場面:人が保守する設定ファイル

向かない場面:JSONだけを受け付けるAPI

XML

向く場面:既存のXML schemaや業務連携

向かない場面:簡潔なWeb APIを新規設計する用途

関連する比較

注意点

  • YAMLをJSONの上位互換として扱いません。
  • 文字コード、型、schemaの扱いを受け手と確認します。

関連Guide

参考資料・仕様