Swagger UI AuthHeader 过滤器 - 授权过滤器不在 FilterDescriptors 中

Question

我为我的 API 设置了 Swagger UI，并希望使用来自 Microsoft.AspNetCore.Authorization 的 [Authorize] 属性为控制器方法添加授权参数

目前我通过谷歌搜索如何设置自定义过滤器类，如下所示：

public class AuthHeaderFilter : Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter
{
    public void Apply(OpenApiOperation operation, OperationFilterContext context)
    {
        var filterPipeline = context.ApiDescription.ActionDescriptor.FilterDescriptors;
        var isAuthorized = filterPipeline.Select(filterInfo => filterInfo.Filter).Any(filter => filter is AuthorizeFilter);
        var allowAnonymous = filterPipeline.Select(filterInfo => filterInfo.Filter).Any(filter => filter is IAllowAnonymousFilter);

        if (isAuthorized && !allowAnonymous)
        {
            if (operation.Parameters == null)
                operation.Parameters = new List<OpenApiParameter>();

            operation.Parameters.Insert(0, new OpenApiParameter
            {
                Name = "Authorization",
                In = ParameterLocation.Header,
                Description = "access token",
                Required = true,
                Schema = new OpenApiSchema
                {
                    Type = "String",
                }
            });
        }
    }
}

问题是没有方法在 UI 上添加授权参数。我用应用了授权属性的方法调试了这个类，发现问题是从FilterDescriptors派生的filterPipeline不包含AuthorizeFilter。是否需要在启动类中添加一些东西来处理如何将此属性添加到我缺少的过滤器中？

Answer 1

在 OpenAPI 3.0 中，标头参数名为 Authorization are ignored。您需要将此标头配置为 security scheme。