Swashbuckle.AspNetCore 对 C required 关键字的支持问题解析

背景介绍

在 C# 11 和 .NET 7 中引入的 required 关键字是一个重要的语言特性，它允许开发者明确标记类属性必须在对象构造时初始化。这个特性与传统的 RequiredAttribute 有着不同的语义和行为，但在 API 文档生成工具 Swashbuckle.AspNetCore 中，这两种标记方式却产生了不同的处理结果。

问题本质

当开发者使用 required 关键字标记属性时，Swashbuckle.AspNetCore 的 SwaggerGen 组件未能像处理 RequiredAttribute 那样将这些属性标记为必填字段。这导致生成的 OpenAPI/Swagger 文档中缺少了必要的参数验证信息，影响了 API 文档的准确性和前端开发者的使用体验。

技术分析

底层机制差异

1. required 关键字：这是 C# 语言层面的编译时检查，确保属性在对象初始化时被赋值。它通过 RequiredMemberAttribute 在 IL 层面实现。

2. RequiredAttribute：这是 System.ComponentModel.DataAnnotations 命名空间下的特性，主要用于运行时验证。

Swashbuckle 的实现

Swashbuckle.AspNetCore 在生成 Schema 时，原本只检查了 RequiredAttribute 的存在，而没有检查 RequiredMemberAttribute。这导致了使用新语法标记的属性在文档中显示为可选参数。

解决方案演进

社区贡献者 Havunen 在 DotSwashbuckle 分支中率先实现了对此功能的支持，通过修改 SchemaGenerator 逻辑，使其同时检查 RequiredMemberAttribute 的存在。这一改动随后被合并到主分支中。

注意事项

值得注意的是，required 关键字与可空性(nullability)是两个独立的概念。开发者可以合法地声明如 required int? 这样的属性，表示该属性必须在构造时初始化，但其值可以为 null。这与 Swagger 文档中的"必填"标记需要正确区分。

最佳实践建议

1. 对于新项目，建议统一使用 required 关键字，因为它提供了编译时检查，更早发现问题。

2. 如果同时需要运行时验证，可以组合使用 required 和 RequiredAttribute。

3. 确保使用的 Swashbuckle.AspNetCore 版本已包含对此特性的支持。

总结

这个问题的解决体现了现代 .NET 生态中语言特性与工具链协同发展的重要性。随着 C# 语言的演进，像 Swashbuckle.AspNetCore 这样的基础设施也需要相应更新，以支持新的语言特性，为开发者提供无缝的开发体验。