C# .NET Core中如何基于YAML Schema验证YAML文件？

常用实现方案 #

• YamlDotNet + JsonSchema.NET
  核心思路是利用YAML与JSON的兼容性，先将YAML转成JSON，再用成熟的JSON Schema验证工具完成校验，步骤如下：

  1. 用YamlDotNet解析YAML文件为.NET对象或直接转成JSON字符串
  2. 将YAML Schema同样转成JSON Schema格式
  3. 使用JsonSchema.NET执行验证逻辑
     示例代码片段：

  // 需安装NuGet包：YamlDotNet、JsonSchema.Net
  using YamlDotNet.Serialization;
  using JsonSchema.Net;
  using System.IO;
  
  // 读取YAML文件内容
  var yamlContent = File.ReadAllText("target.yaml");
  var deserializer = new DeserializerBuilder().Build();
  var yamlObj = deserializer.Deserialize<object>(yamlContent);
  
  // 转换为JSON格式
  var jsonSerializer = new SerializerBuilder().JsonCompatible().Build();
  var jsonContent = jsonSerializer.Serialize(yamlObj);
  
  // 加载并转换YAML Schema为JSON Schema
  var schemaContent = File.ReadAllText("schema.yaml");
  var schemaObj = deserializer.Deserialize<object>(schemaContent);
  var schemaJson = jsonSerializer.Serialize(schemaObj);
  var schema = JsonSchema.FromJson(schemaJson);
  
  // 执行验证
  var validationResult = schema.Evaluate(jsonContent);
  if (!validationResult.IsValid)
  {
      foreach (var error in validationResult.Errors)
      {
          Console.WriteLine($"验证失败: {error.Message}");
      }
  }
  

• NetFabric.YamlSchema
  这是专门针对YAML Schema验证的类库，无需转JSON，直接支持YAML格式的Schema文件，使用更简洁：

  1. 安装NuGet包NetFabric.YamlSchema
  2. 直接加载Schema和目标YAML文件执行验证
     示例代码片段：

  // 需安装NuGet包：NetFabric.YamlSchema
  using NetFabric.YamlSchema;
  using System.IO;
  
  var schema = YamlSchema.LoadFromFile("schema.yaml");
  var yamlContent = File.ReadAllText("target.yaml");
  var validationResults = schema.Validate(yamlContent);
  
  if (!validationResults.IsValid)
  {
      foreach (var failure in validationResults.Failures)
      {
          Console.WriteLine($"路径: {failure.Path} | 错误信息: {failure.Message}");
      }
  }
  

注意要点 #

• 确保你的YAML Schema符合官方规范（如YAML Schema Draft版本），部分库仅支持特定版本的Schema
• 针对复杂嵌套的Schema，建议先编写测试用例覆盖核心校验规则，避免遗漏

内容的提问来源于stack exchange，提问作者Ashwin