为 API 示例与严格流水线将 YAML 转为 JSON

适用场景

用 YAML 写得快,但消费者要 JSON 字面量:转换会暴露类型与重复键问题。

要使用的工具

将 YAML 转为 JSON。

打开 YAML 转 JSON →

步骤

  1. 1查找重复 YAML 键(常静默以最后一个为准)。
  2. 2转换后按 schema 或 OpenAPI 示例校验。
  3. 3确认“像数字”的字符串是否应保持为字符串。
  4. 4将 JSON 片段与源 YAML 一并版本化备审计。

示例

  • README 块换成 SDK 测试用 JSON。
  • 构建任务只接受来自已编辑 YAML 的 JSON 覆盖。

应避免

  • 使用 JSON 无法表达的 YAML 合并键。
  • 忽略转换后的时区或 ISO-8601 预期。
  • 科学计数法在不同语言中解析不同。

相关工具

博客

开发者与数据工具 中的更多内容

所有任务指南 或前往 开发者与数据工具 专区.

常见问题

注释?

JSON 会删掉:带注释的 YAML 留在 git。

null 与空串?

两者都要审计;很多迁移栽在这。

所有任务指南 · 开发者与数据工具 工具 · 博客