swashbuckle头部的API密钥

2016-05-02 69 views 3 likes

我想用Swashbuckle（为.net开口）在WebAPI项目上进行基于API密钥的身份验证。swashbuckle头部的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密钥的头而不是查询字符串？

来源

2016-05-02 Luke McGregor

回答

检查出来：

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

来源

2017-04-07 15:47:46

看起来更好的生病下周尝试它的欢呼。 –

它只是工作，它的好得多 –

这对我有用。调整swagger配置设置时，请确保运行'iisreset'命令（如果使用的是完整的IIS）。配置有时会被缓存，并且您不会看到更改。 –

你必须注入（如描述here）的基础上original定制index.html，然后更改以下行的功能addApiKeyAuthorization：

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

来源

2016-05-02 20:46:21 venerik

这很吸引人的解决方案，但它似乎是唯一的方法来做到这一点:( –

swashbuckle头部的API密钥

回答

相关问题