FastEndpoints中如何选择性排除Swagger默认参数

在基于FastEndpoints构建的API项目中，开发者经常需要处理全局性请求头参数的管理问题。本文将以一个典型场景为例，详细介绍如何优雅地实现Swagger文档中默认参数的动态控制。

场景背景

在RESTful API设计中，某些自定义请求头（如x-custom-header）可能被绝大多数端点所使用，但又不适合在每个端点定义中重复声明。常见的实现方式是通过HttpContext扩展方法在中间件或端点处理器中获取这些头信息。

当使用FastEndpoints生成OpenAPI/Swagger文档时，我们需要确保文档能准确反映这些隐式参数要求。典型的解决方案是通过OperationProcessor全局添加参数声明，但这会导致所有端点都显示该参数，而实际可能存在少数不需要该参数的端点。

技术实现方案

基础配置方法

首先在服务注册时配置全局OperationProcessor：

builder.Services.AddFastEndpoints()
    .SwaggerDocument(opts =>
    {
        opts.DocumentSettings = s =>
        {
            s.OperationProcessors.Add(new HeaderOperationProcessor());
        };
    });

其中HeaderOperationProcessor是实现参数添加的核心类：

public class HeaderOperationProcessor : IOperationProcessor
{
    public bool Process(OperationProcessorContext ctx)
    {
        var operation = ctx.OperationDescription.Operation;
        var endpointDef = ctx.GetEndpointDefinition();
        
        // 检查端点是否标记为不需要头参数
        if (endpointDef?.EndpointTags?.Contains("ExcludeHeader") is true)
            return true;

        operation.Parameters.Add(new OpenApiParameter
        {
            Name = "x-custom-header",
            Kind = OpenApiParameterKind.Header,
            Schema = new JsonSchema { Type = JsonObjectType.String },
            Description = "业务必需的自定义请求头",
            Required = true
        });

        return true;
    }
}

端点级控制

对于不需要该头参数的端点，只需添加特定标签即可：

public class PublicEndpoint : Endpoint<Request, Response>
{
    public override void Configure()
    {
        Get("/api/public-data");
        Tags("ExcludeHeader");  // 添加排除标记
        AllowAnonymous();
    }
    
    public override async Task HandleAsync(Request req, CancellationToken ct)
    {
        // 端点逻辑...
    }
}

进阶讨论

1. 多条件判断：可在OperationProcessor中实现更复杂的判断逻辑，如基于路由前缀、HTTP方法或其他自定义属性

2. 参数继承：考虑创建层次化的参数定义系统，支持从父类继承参数配置

3. 动态必填：根据运行环境（如开发/生产）动态调整参数的required属性

4. 文档分组：结合Swagger文档分组功能，实现不同API版本采用不同的全局参数策略

最佳实践建议

1. 保持一致性：建议使用明确的命名约定（如"Exclude*"前缀）来标识特殊行为

2. 文档补充：在Swagger描述中明确说明全局参数的使用规则

3. 测试验证：确保SwaggerUI生成的客户端代码能正确处理参数排除情况

4. 性能考量：OperationProcessor中的逻辑应保持轻量，避免复杂计算

这种方案既保持了代码的整洁性，又提供了足够的灵活性，是处理API文档中全局参数的理想选择。