使用Swashbuckle Swagger和Asp.Net Core如何将Api Key作为请求默认头的值传递？

Question

使用Swashbuckle Swagger和Asp.Net Core如何将Api Key作为请求默认头的值传递？

swaggerswagger-uiopenapiswashbuckle

5

我有一个基本的Api，它接受一个默认的头部值my-api-key和相应的值。

我正在尝试使Swagger UI允许我一次输入授权头部，并使键/值随每个请求传递。

到目前为止，我只成功地将头部显式添加为每个端点的参数，但这并不理想。

相关的代码片段：

        services.AddApiVersioning(
            options =>
            {
                // reporting api versions will return the headers "api-supported-versions" and "api-deprecated-versions"
                options.ReportApiVersions = true;
            });
        services.AddVersionedApiExplorer(
            options =>
            {
                // add the versioned api explorer, which also adds IApiVersionDescriptionProvider service
                // note: the specified format code will format the version as "'v'major[.minor][-status]"
                options.GroupNameFormat = "'v'VVV";

                // note: this option is only necessary when versioning by url segment. the SubstitutionFormat
                // can also be used to control the format of the API version in route templates
                options.SubstituteApiVersionInUrl = true;
            });

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

            // this isn't ideal as I have to fill in the Api Key on ever request
            //c.OperationFilter<ApiKeySwaggerFilter>();

            c.AddSecurityDefinition("ApiKey", new OpenApiSecurityScheme
            {
                Type = SecuritySchemeType.ApiKey,
                Name = "my-api-key",
                In = ParameterLocation.Header
            });

            c.AddSecurityRequirement(new OpenApiSecurityRequirement
            {
                { new OpenApiSecurityScheme()
                        {
                         // Type = SecuritySchemeType.ApiKey,
                            Name = ""
                            //In = ParameterLocation.Header
                            //Reference = new OpenApiReference()
                            //{
                            //  Id = "myToken",
                            //  Type = ReferenceType.SecurityScheme
                            //},
                }, new string[] { }
                }
            });
        });

app.UseSwagger();

    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "Api v1");
        c.SwaggerEndpoint("/swagger/v2/swagger.json", "Api v2");
    });

我所在位置的对应图像：

对应的最小跳变：https://github.com/aherrick/SwaggerSample

我感觉这已经很接近了，但是如何让API标头在每个请求中都得到传递，而不必强制用户在每个方法请求中填写参数。

- aherrick

用户点击绿色的“授权”按钮并在那里输入API密钥。然后，此API密钥将随所有请求一起发送。这不是您所需要的吗？ - Helen

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- aherrick · Accepted Answer

通过以下部分的更新弄清楚了：

           c.AddSecurityDefinition("ApiKey", new OpenApiSecurityScheme
            {
                Description = "Enter your Api Key below:",
                Name = "my-api-key",
                In = ParameterLocation.Header,
                Type = SecuritySchemeType.ApiKey
            });

            c.AddSecurityRequirement(new OpenApiSecurityRequirement()
                {
                    {
                      new OpenApiSecurityScheme
                        {
                            Reference = new OpenApiReference
                            {
                                Type = ReferenceType.SecurityScheme,
                                Id = "ApiKey"
                            },
                        },
                        new List<string>()
                    }
                });