Format Atlas

指南

选择 Web 数据与配置格式

API 等机器间交换可考虑 JSON；人工编辑的配置可考虑 YAML；已有 Schema 的集成可考虑 XML。

应该选择哪种格式？

根据文件在工作流程中的用途选择格式。

  • Web API 数据 → JSON
  • 人工编辑的设置 → YAML
  • 现有 Schema 或接口 → XML

遵循接收方要求的格式

三者都能表示结构化数据，但语法、注释、类型解释和 Schema 流程不同。先核对接口及工具支持。

候选格式

JSON

适用于: API 和基于 JSON 的交换

不太适用于: 需要注释的手工配置

YAML

适用于: 人工维护的配置

不太适用于: 只接受 JSON 的 API

XML

适用于: 现有 XML Schema 和集成

不太适用于: 没有 XML 要求的新简单 API

导出前注意事项

  • 不要假定 YAML 是 JSON 的严格超集。
  • 与接收方确认编码、类型和 Schema 处理。

相关比较

JSON vs YAMLJSON 是常用于 API 和程序间数据交换的严格文本格式。YAML 的语法适合人工编辑配置和结构化数据。应结合工具生态与工作流选择。XML vs JSONXML 和 JSON 都是结构化数据文本格式，但采用不同的结构和约定。

指南

选择数据交换格式先看接收系统的规范。结构化 API 数据可用 JSON；需要既有 Schema 的集成用 XML；单一表格可用 CSV。

参考资料与规范