YAML 架构验证？

Question

YAML 是否有模式验证语言？我用谷歌搜索但找不到任何有用的东西。

像 XSD 格式这样的东西，使用语言本身来描述模式，对我来说是最好的选择。

Answer 1

JSON Schema 可与大多数 YAML 文档一起使用，从而产生比 Rx 或 夸化。 JSON Schema 是我能够找到的三个中唯一的编辑器支持< /a>.

有关使用 YAML 和 JSON Schema 的更多信息（包括工具和编辑器支持）可在此页面上跟踪。在撰写本文时，Visual Studio Code 中提供了编辑器支持，并且通过 npm 提供了基于命令行的验证工具。

---

全面披露：我创建了上面链接的网站，试图使 JSON 模式在 YAML 中的应用更容易被发现。我还为 VS Code 编写了一个编辑器扩展，该扩展已被上面链接的 RedHat 扩展所取代。

Answer 2

尝试 Kwalify（仅限 Ruby 和 Java），或 Rx（多种语言）

Answer 3

我想知道为此重用 JSON 模式是否有意义。 YAML 可以轻松转换为 JSON，而不会丢失任何信息（？），因此理论上 YAML 可以通过相同的工具链进行验证，从而允许开源社区专注于一个好的模式工具链。架构本身也可以用 YAML 编写并转换为 JSON。

Answer 4

好主意。谷歌搜索这个，因为我正在寻找相同的东西。

可以按照定义的方式将 YAML 转换为 XML（类似于 JSON <-> XML）并使用标准 XML 验证器进行验证。

根据您的平台，有用于该转换的工具或片段： JavaScript ( NPM)、Ruby、Java (Jackson), Java (TestNG) （您需要查看其所需参数的源代码）。

如果使用 API 完成，错误位置甚至可以映射回原始 YAML 文件。

Answer 5

您可以使用此 python ysd 项目来验证您的 yaml 文件。 https://github.com/yonahd/ysd
使用超级简单

python yaml-validator/main.py -v yamls/example-values.yaml -r yamls/example-rules.yaml 

规则文件示例：

required: // field must exist and type must match
  env: str
  enabled: bool
  replicas: int
optional: // if field exists type must match
  disk: str

yaml 文件示例（helm 值文件）：

network:
  service:
    port: 8060
enabled: true
image:
  app: my-app:build
replicas: 1
env: dev
disk: local

Answer 6

如果您的项目是 C++ 语言，您还可以使用 yaml-schema- cpp 库。它允许使用 C++ 代码中的架构文件（扩展名为 .schema 的 YAML 文件）来验证（并完成）.yaml 输入文件。