Swashbuckle.AspNetCore 中非空引用类型自动标记为必填项的实现

在 ASP.NET Core 开发中，Swashbuckle.AspNetCore 是一个广泛使用的库，用于自动生成 OpenAPI/Swagger 文档。随着 C# 8.0 引入的可空引用类型特性，开发者现在可以更明确地表达哪些属性可以为 null，哪些不能。本文将深入探讨如何让 Swashbuckle.AspNetCore 自动将非空引用类型属性标记为 OpenAPI 规范中的必填项(required)。

背景与需求

在 OpenAPI 规范中，必填字段通过 required 数组来标识。对于 Web API 开发，通常希望将模型中的非空属性自动标记为必填项，这样可以更准确地反映 API 的契约。然而，默认情况下，Swashbuckle.AspNetCore 并不会自动将 C# 的非空引用类型属性映射为 OpenAPI 的必填字段。

解决方案演进

早期开发者需要通过自定义过滤器来实现这一功能，例如编写特定的 Schema 过滤器来检查属性的可空性并手动添加 required 标记。这种方法虽然可行，但增加了额外的配置工作。

随着 Swashbuckle.AspNetCore 的更新，现在可以通过更简洁的方式实现这一功能。核心方法是使用 SupportNonNullableReferenceTypes 扩展方法，并启用 NonNullableReferenceTypesAsRequired 选项。

实现方式

在最新的 Swashbuckle.AspNetCore 版本中，可以通过以下配置实现自动标记：

services.AddSwaggerGen(c =>
{
    c.SupportNonNullableReferenceTypes();
    // 或者更明确的配置
    c.SchemaFilter<NonNullableSchemaFilter>();
});

其中 SupportNonNullableReferenceTypes 方法内部已经实现了将非空引用类型标记为必填项的逻辑。对于需要更细粒度控制的场景，开发者仍然可以创建自定义的 ISchemaFilter 实现。

技术细节

这一功能的实现原理主要基于：

1. 利用 C# 编译器的可空引用类型元数据信息
2. 在 Swashbuckle 的文档生成管道中分析类型的可空性注解
3. 自动将非空属性添加到 OpenAPI Schema 的 required 列表中

值得注意的是，这一功能与 C# 的 required 关键字是正交的。required 关键字提供了一种显式声明必填属性的方式，而自动标记则是基于类型系统的隐式推断。

最佳实践

在实际项目中，建议：

1. 对于新项目，直接启用 SupportNonNullableReferenceTypes
2. 对于已有项目，逐步迁移到非空引用类型，同时评估自动标记的影响
3. 在需要特别控制的地方，可以混合使用 required 关键字和自动标记
4. 编写单元测试验证生成的 OpenAPI 文档是否符合预期

总结

Swashbuckle.AspNetCore 对非空引用类型的支持使得 API 文档能够更准确地反映代码的语义契约。通过合理配置，开发者可以省去手动维护必填字段列表的工作，同时保证 API 文档的准确性。这一特性特别适合大型项目或严格遵循契约设计的 API 开发场景。