c.OperationFilter()

在Swagger API文档生成器中，c.OperationFilter()被用来添加API调用授权的标头参数。

该操作过滤器将授权标头参数添加到每个API操作的Swagger UI页面中，以便程序员可以使用授权标头调用API。

使用方法

在ASP.NET Core应用程序的Swagger配置中，使用以下代码添加OperationFilter：

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });

    // 将操作过滤器添加到配置
    c.OperationFilter<AuthorizationHeaderParameterOperationFilter>();
});

在添加完该操作过滤器后，Swagger UI页面将添加该授权标头参数，以便程序员在访问API时提供授权信息。

示例

下面是添加授权标头参数的示例：

public class AuthorizationHeaderParameterOperationFilter : IOperationFilter
{
    public void Apply(OpenApiOperation operation, OperationFilterContext context)
    {
        var jwtSecurityScheme = new OpenApiSecurityScheme
        {
            Scheme = "bearer",
            BearerFormat = "JWT",
            Name = "Authorization",
            In = ParameterLocation.Header,
            Type = SecuritySchemeType.ApiKey,
            Description = "JWT Authorization header using the Bearer scheme."
        };

        operation.Security = new List<OpenApiSecurityRequirement>
        {
            new OpenApiSecurityRequirement
            {
                [jwtSecurityScheme] = new string[]{ }
            }
        };
    }
}

在该示例中，我们将JWT授权添加到API操作。以JWT作为安全方案，并将它添加到openapi安全需求中。

结论

使用c.OperationFilter()，您可以在Swagger UI页面上添加API调用授权标头参数。通过在API操作中添加授权标头，程序员可以更容易地使用对保护API的访问控制。

该操作过滤器非常灵活，您可以设置授权标头的名称、位置和格式，以适应您的应用程序需求。

要了解更多Swagger API文档生成器配置，请访问 Swagger官方文档.