如何强制 Swagger/Swashbuckle 附加一个 API 键？

Question

我有一个 .NET Core 2.x 项目，它集成了 Swagger 和 Swashbuckle v4.x。这一切都非常有效。

但是，现在我需要以 www.foo.com/myendpoint?authorization=APIKEY 的形式将查询字符串附加到 Swagger 触发的每个 GET。为此，我在 Startup.ConfigureServices 中有以下内容：

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

  c.AddSecurityDefinition("api key", new ApiKeyScheme() {
      Description = "Authorization query string expects API key",
      In = "query",
      Name = "authorization",
      Type = "apiKey"
  });
});

当我启动 swagger 时，它会向我显示一个对话框并在我输入 API 键时成功接受它。但是，所有 API 调用仍然在没有查询字符串的情况下发出。

我错过了什么？

Answer 1

特别是 Swashbuckle，（NSwag 有它自己的注册授权流程的方法）仅仅定义安全定义是不够的，您还需要注册使用它的操作。

由于您想将 api-key 附加到所有操作，因此您的用例非常简单：只需为您的定义注册安全要求，您可以这样做：

c.AddSecurityRequirement(new Dictionary<string, IEnumerable<string>> { { "api key", new[] {} } };

您可以详细了解如何为您的操作定义、自定义和注册不同的授权方案here。

对于即将发布的 Swashbuckle v5，可以使用以下代码：

c.AddSecurityDefinition("api key", new OpenApiSecurityScheme {
    Type = SecuritySchemeType.ApiKey,
    In = ParameterLocation.Query,
    Name = "authorization",
    Description = "Authorization query string expects API key"
});

var key = new OpenApiSecurityScheme() { Name = "api key"};
var requirement = new OpenApiSecurityRequirement {
    { key, new List<string>() }
};
c.AddSecurityRequirement(requirement);

如何强制 Swagger/Swashbuckle 附加一个 API 键？

How to force Swagger/Swashbuckle to append an API key?

c#

swagger

.net-core

swashbuckle