Swashbuckle.AspNetCore 中对 Length 属性的支持实现

背景介绍

在 ASP.NET Core 开发中，Swashbuckle.AspNetCore 是一个广泛使用的库，用于自动生成 API 文档。它能够将 .NET 中的模型验证特性转换为 OpenAPI/Swagger 规范。在数据验证方面，System.ComponentModel.DataAnnotations 命名空间提供了多种验证属性，其中与字符串长度相关的有三个主要属性：MinLength、MaxLength 和 Length。

问题发现

在 .NET 8 之前，开发者只能使用 MinLength 和 MaxLength 两个属性来分别指定字符串的最小和最大长度。而在 .NET 8 中，微软引入了 Length 属性，它能够在一个属性中同时指定最小和最大长度限制。然而，Swashbuckle.AspNetCore 最初并未支持这个新属性。

技术分析

Length 属性与传统的 MinLength/MaxLength 组合在功能上是等效的，但提供了更简洁的语法。例如：

[MinLength(2), MaxLength(10)]
public string Prop1 { get; set; }

[Length(2, 10)]
public string Prop2 { get; set; }

在 Swashbuckle.AspNetCore 6.6.2 版本之前，上述代码生成的 OpenAPI 规范中，Prop1 会正确显示 minLength 和 maxLength 约束，而 Prop2 则完全不会有长度限制的说明。

解决方案实现

随着 Swashbuckle.AspNetCore 升级到支持 .NET 8，开发团队实现了对 Length 属性的支持。实现的核心是一个 SchemaFilter，它会检查模型属性上的 Length 属性，并将其转换为 OpenAPI 规范中的 minLength 和 maxLength 约束。

对于暂时无法升级到 .NET 8 的项目，开发者可以自行实现一个临时的 SchemaFilter：

internal sealed class LengthAttributeSupportSchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        if (context.MemberInfo is null) return;

        var lengthAttributes = context.MemberInfo
            .GetInlineAndMetadataAttributes()
            .OfType<LengthAttribute>();
            
        foreach (var attr in lengthAttributes)
        {
            if (schema.Type == "array")
            {
                schema.MinItems = attr.MinimumLength;
                schema.MaxItems = attr.MaximumLength;
            }
            else
            {
                schema.MinLength = attr.MinimumLength;
                schema.MaxLength = attr.MaximumLength;
            }
        }
    }
}

版本兼容性考虑

需要注意的是，Length 属性是 .NET 8 引入的新特性。在 Swashbuckle.AspNetCore 升级到支持 .NET 8 之前，即使代码中使用了 Length 属性，也无法直接获得支持。这也是为什么在早期版本中需要开发者自行实现 SchemaFilter 的原因。

最佳实践

对于新项目，建议：

1. 使用最新版本的 Swashbuckle.AspNetCore
2. 优先使用 Length 属性替代 MinLength/MaxLength 组合
3. 确保 API 文档生成配置中包含对 Length 属性的支持

对于现有项目升级：

1. 先升级到 .NET 8
2. 再升级 Swashbuckle.AspNetCore 到 6.6.2 或更高版本
3. 逐步将现有的 MinLength/MaxLength 组合替换为 Length 属性

总结

Swashbuckle.AspNetCore 6.6.2 版本正式加入了对 Length 属性的支持，使得 .NET 8 开发者能够更简洁地表达字符串长度约束，并自动生成准确的 API 文档。这一改进体现了 Swashbuckle.AspNetCore 项目对新版 .NET 特性的快速响应能力，也为开发者提供了更优雅的代码编写方式。