swashbuckle頭部的API密鑰

Question

我想用Swashbuckle（爲.net開口）在WebAPI項目上進行基於API密鑰的身份驗證。

我已經配置swashbuckle如下：

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）

這似乎創造招搖文件我想到：

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

但是，當我去到UI和'試一試'它試圖將API密鑰放入查詢字符串（我認爲是默認行爲）而不是頭部。

如：

curl -X POST --header 'Accept: application/json' 'http://localhost:63563/api/MyMethod?api_key=key'

怎樣才能昂首闊步使用把API密鑰的頭而不是查詢字符串？

Answer 1

檢查出來：

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"); 
    }) 

Answer 2

你必須注入（如描述here）的基礎上original定製index.html，然後更改以下行的功能addApiKeyAuthorization：

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