对于某些特定的控制器，排除使用Swashbuckle (OpenApiParameter)添加的默认头部参数

在软件开发中，控制器是处理HTTP请求并返回响应的核心组件。Swashbuckle（现在通常称为NSwag）是一个流行的库，用于为ASP.NET Core应用程序自动生成OpenAPI文档。OpenApiParameter是Swashbuckle中的一个特性，允许开发者自定义API参数，包括默认头部参数。

基础概念

控制器（Controller）：在MVC（Model-View-Controller）架构中，控制器负责处理用户输入，处理业务逻辑，并返回相应的视图或数据。

Swashbuckle/OpenAPI：Swashbuckle是一个用于生成Swagger/OpenAPI文档的工具，它可以帮助开发者自动创建和维护API文档。

OpenApiParameter：这是Swashbuckle中的一个类，用于定义API参数的详细信息，包括参数的位置（路径、查询、头部等）。

类型与应用场景

类型：

路径参数（Path Parameters）
查询参数（Query Parameters）
表单参数（Form Parameters）
头部参数（Header Parameters）

应用场景：

当API需要接收特定的头部信息时，可以使用OpenApiParameter来定义这些参数。
在构建微服务架构时，清晰的API文档对于服务间的集成至关重要。

遇到的问题及解决方法

如果你想要排除某些特定的控制器中使用Swashbuckle添加的默认头部参数，可以采取以下方法：

方法一：使用特性排除

你可以创建一个自定义的特性（Attribute），并在不需要默认头部参数的控制器或方法上应用这个特性。

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
public class ExcludeDefaultHeaderAttribute : Attribute { }

public void Apply(OperationFilterContext context)
{
    if (context.ApiDescription.ActionDescriptor.EndpointMetadata.Any(em => em is ExcludeDefaultHeaderAttribute))
    {
        context.Operation.Parameters.RemoveAll(p => p.In == ParameterLocation.Header && p.Name == "default-header-name");
    }
}

然后在Startup.cs中注册这个过滤器：

services.AddSwaggerGen(c =>
{
    c.OperationFilter<ExcludeDefaultHeaderFilter>();
});

方法二：手动移除参数

在配置Swagger生成器时，你可以手动检查并移除特定的头部参数。

services.AddSwaggerGen(c =>
{
    c.OperationFilter(context =>
    {
        var parameters = context.ApiDescription.ActionDescriptor.EndpointMetadata.OfType<OpenApiParameter>();
        foreach (var param in parameters)
        {
            if (param.In == ParameterLocation.Header && param.Name == "default-header-name")
            {
                context.Operation.Parameters.Remove(param);
            }
        }
        return Task.CompletedTask;
    });
});