带有虚张声势的标头中的 API 密钥

Question

我想使用Swashuckle（swagger for. net）在WebAPI项目上进行基于API密钥的身份验证。

我已经配置了如下虚张声势：

config
    .EnableSwagger(c =>
    {
        c.ApiKey("apiKey")
            .Description("API Key Authentication")
            .Name("X-ApiKey")
            .In("header");
        c.SingleApiVersion("v1", "My API");

    })
    .EnableSwaggerUi();

（见 https://github.com/domaindrivendev/Swashbuckle#describing-securityauthorization-schemes）

它似乎创建了我所期望的swagger文件:

   "securityDefinitions": {
      "apiKey": {
        "type": "apiKey",
        "description": "API Key Authentication",
        "name": "X-ApiKey",
        "in": "header"
      }
    }

但是当我进入UI并‘尝试’时，它试图将API键放入查询字符串(我认为这是默认行为)而不是头。

例如：

curl-X POST——标题“Accept:application/json”http://localhost:63563/api/MyMethod?api_key=key“

如何让 swagger 使用将 API 密钥放在标头中而不是查询字符串中？

Answer 1

您必须在原始的基础上注入一个自定义的index.html(如这里所述),并在函数< code > addApiKeyAuthorization 中更改下面一行:

var apiKeyAuth = new SwaggerClient.ApiKeyAuthorization("X-ApiKey", key, "header");

Answer 2

正如贾斯汀·格雷沃尔夫的评论中已经指出的那样。

“In”和“Type”属性已从字符串更改为< code>ParameterLocation和< code>SecuritySchemeType枚举:

services.AddSwaggerGen(c =>{
    c.SwaggerDoc("v1", new Info { Title = "[anything]", Version = "v1" });
    c.AddSecurityDefinition("[auth scheme: same name as defined for asp.net]", new ApiKeyScheme() {
        In = ParameterLocation.Header,
        Name = "X-API-KEY", //header with api key
        Type = SecuritySchemeType.ApiKey,
    });
});

范式已经转变，以适应生成的swagger.json中的安全定义

来源https://github.com/domaindrivendev/Swashbuckle.AspNetCore # add-安全定义和要求

services.AddSwaggerGen(c =>{
    c.SwaggerDoc("v1", new Info { Title = "[anything]", Version = "v1" });
    c.AddSecurityDefinition("[auth scheme: same name as defined for asp.net]", new ApiKeyScheme() {
        In = "header", // where to find apiKey, probably in a header
        Name = "X-API-KEY", //header with api key
        Type = "apiKey", // this value is always "apiKey"
    });

});

检查出来：

config
    .EnableSwagger(c =>
    {
        c.ApiKey("apiKey")
            .Description("API Key Authentication")
            .Name("X-ApiKey")
            .In("header");
        c.SingleApiVersion("v1", "My API");

    })
    .EnableSwaggerUi(c => {
        c.EnableApiKeySupport("X-ApiKey", "header");
    })