Swashbuckle.AspNetCore 中继承类Schema处理的正确方式

在Swashbuckle.AspNetCore 6.6.1版本中，一个关于继承类Schema处理的变更引发了一些开发者的困惑。本文将详细解析这一变更的技术背景、正确实现方式以及如何调整现有代码以适应新版本。

问题背景

在6.6.1版本之前，当使用ISchemaFilter处理继承类时，可以直接通过schema.Properties访问子类的所有属性。例如，对于以下类结构：

public class CoffeeMachine : Machine
{
    public string BeanType { get; set; }
}

开发者可以通过以下代码获取子类属性：

public void Apply(OpenApiSchema schema, SchemaFilterContext context)
{
    int propertiesCount = schema.Properties.Count; // 6.5.0版本返回1
}

然而，从6.6.1版本开始，这种直接访问方式不再有效，schema.Properties.Count返回0，这导致许多依赖此行为的代码（如标记所有属性为必需的过滤器）无法正常工作。

技术解析

这一变更实际上是修复了一个长期存在的Schema生成问题。根据OpenAPI规范：

1. 使用allOf进行继承时，所有属性（包括基类属性和子类属性）都应该包含在allOf数组中
2. 基类属性通过$ref引用
3. 子类属性定义在allOf数组的最后一个元素中

6.6.1版本之前的实现存在以下问题：

• 错误地将子类属性直接放在Schema的顶级properties中
• 没有严格遵循OpenAPI规范中的继承表示方式

正确的Schema表示应该如下：

{
  "CoffeeMachine": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Machine"
      },
      {
        "type": "object",
        "properties": {
          "beanType": {
            "type": "string",
            "nullable": true
          }
        }
      }
    ]
  }
}

解决方案

对于需要处理继承类属性的场景，开发者应该调整代码逻辑，改为遍历allOf数组来访问属性。例如，要将所有属性标记为必需的过滤器应修改为：

public void Apply(OpenApiSchema schema, SchemaFilterContext context)
{
    foreach (var model in schema.AllOf)
    {
        var additionalRequiredProps = model.Properties
            .Where(x => !model.Required.Contains(x.Key))
            .Select(x => x.Key);
        
        foreach (var propKey in additionalRequiredProps)
        {
            model.Required.Add(propKey);
        }
    }
}

这种实现方式：

1. 正确处理了继承类结构
2. 遵循了OpenAPI规范
3. 与Swashbuckle.AspNetCore 6.6.1+版本兼容

最佳实践

在使用Swashbuckle.AspNetCore处理继承类时，建议：

1. 始终检查schema.AllOf是否存在内容
2. 对于继承类，属性通常位于allOf数组的最后一个元素
3. 考虑同时处理直接属性和allOf中的属性以确保兼容性
4. 在编写SchemaFilter时，明确区分基类属性和子类属性的处理逻辑

总结

Swashbuckle.AspNetCore 6.6.1版本的这一变更虽然破坏了部分现有代码，但带来了更符合OpenAPI规范的实现。开发者应理解这一变更的技术背景，及时调整相关代码，以确保生成的API文档正确反映实际的类结构。通过遵循规范和建议的最佳实践，可以构建出更健壮、可维护的API文档生成逻辑。