FastEndpoints 中 Swagger 响应模型非空约束的配置方法

在使用 FastEndpoints 框架开发 Web API 时，开发者可能会遇到 Swagger 文档中响应模型(Response DTO)的非空约束(Non-nullable)未能正确生成的问题。本文将详细介绍这一问题的背景和解决方案。

问题背景

在 FastEndpoints 中，请求模型(Request DTO)通过 FluentValidation 配置的验证规则能够正确反映到生成的 Swagger 文档中。例如，当使用 RuleFor(x => x.Property).NotNull() 时，Swagger 会将该属性标记为必需(required)且不可为空(non-nullable)。

然而，对于响应模型(Response DTO)，即使配置了相同的验证规则，Swagger 文档也不会自动包含这些约束信息。这会导致客户端生成的类型定义包含不必要的空值检查，影响开发体验。

根本原因

FastEndpoints 的设计初衷是验证器主要用于请求模型验证，而非响应模型。因此框架默认不会将响应模型的验证规则应用到 Swagger 文档生成过程中。

解决方案

基础解决方案

FastEndpoints 提供了一个内置方法来自动标记所有非空属性为必需：

builder.Services.SwaggerDocument(options =>
{
    options.DocumentSettings = s =>
    {
        s.MarkNonNullablePropsAsRequired();
    };
});

此配置会扫描所有模型，将非空属性自动添加到 Swagger 的 required 数组中。

高级自定义方案

如果需要更精细的控制，特别是针对数组类型的非空约束，可以自定义 Schema 处理器：

public class MarkNonNullableArrayPropsAsRequired : ISchemaProcessor
{
    public void Process(SchemaProcessorContext context)
    {
        foreach (var (_, prop) in context.Schema.ActualProperties)
        {
            if (!prop.IsNullable(SchemaType.OpenApi3) && prop.IsArray)
            {
                prop.IsRequired = true;
                prop.IsNullableRaw = false;
            }
        }
    }
}

然后在配置中注册：

builder.Services.SwaggerDocument(options =>
{
    options.DocumentSettings = s =>
    {
        s.MarkNonNullablePropsAsRequired();
        s.SchemaSettings.SchemaProcessors.Add(new MarkNonNullableArrayPropsAsRequired());
    };
});

最佳实践

1. 优先使用内置方法：对于大多数场景，MarkNonNullablePropsAsRequired 已足够满足需求。

2. 谨慎自定义：只有在确实需要特殊处理时才实现自定义 Schema 处理器，避免过度工程化。

3. 保持一致性：确保请求模型和响应模型的约束在 Swagger 文档中表现一致，提升 API 使用体验。

4. 文档注释补充：虽然技术约束会自动生成，但仍建议为重要属性添加文档注释，提升 API 可理解性。

通过合理配置，开发者可以确保 FastEndpoints 生成的 Swagger 文档准确反映所有模型约束，为客户端开发提供清晰明确的接口定义。