YAML 文件的接口/默认定义

Question

我有一个配置文件，想要标准化密钥。 因此，当其他开发人员创建自己的配置时，它们将得到验证。

当使用编程语言时，你使用的是接口。

我还知道，某些基于 YAML 的工具（例如 Ansible）也有默认值/定义，以确保您正确编写内容。但据我所知，它们还可以与插件等一起使用...

那么有没有办法在 YAML 文件中实现这种效果？

我的意思是我可以以某种方式以编程方式验证它，但也许有更好的东西。

Answer 1

您有两个选择：

• 使用 JSON 架构。一些编辑器和验证器提供直接的 YAML 支持，而对于其他编辑器和验证器，您需要先将 YAML 转换为 JSON 才能进行验证（这可以自动完成）。请参阅实现。这将限制您只能使用 JSON 中可用的功能（例如，没有复杂的键、锚点和正在解析的别名等）。
• 使用目标类型作为架构。 YAML 是一种序列化语言，这意味着您选择的编程语言中的本机类型充当架构。这显然不适用于具有动态类型的语言，例如 Python 或 JavaScript。它可以在 Java（通过 SnakeYAML）、C#（通过 YamlDotNet）和其他语言中工作。您无法获得自动编辑器支持，但您可以编写一个小型验证器工具，甚至现在使用 LSP 为您最喜欢的编辑器编写验证器工具也很简单。

Ansible（以及许多其他基于 YAML 的框架）实际上并不是一个很好的例子，因为它在 YAML 之上使用 Jinja，因此验证起来要复杂得多。