Propriedade x-amazon-apigateway-api-key-source - Amazon API Gateway
Exemplo de x-amazon-apigateway-api-key-source

Propriedade x-amazon-apigateway-api-key-source

Especifique a origem para receber uma chave de API a fim de controlar os métodos de API que exigem uma chave. Essa propriedade no nível da API é do tipo String. Para saber mais sobre como configurar um método para exigir uma chave de API, consulte Configurar um método para usar chaves de API com uma definição OpenAPI.

Especifique a origem da chave de API para as solicitações. Os valores válidos são:

  • HEADER para receber a chave de API do cabeçalho X-API-Key de uma solicitação.

  • AUTHORIZER para receber a chave da API do UsageIdentifierKey de um autorizador do Lambda (anteriormente conhecido como autorizador personalizado).

Exemplo de x-amazon-apigateway-api-key-source

O exemplo a seguir define o cabeçalho X-API-Key como a origem da chave de API.

OpenAPI 2.0
{
  "swagger" : "2.0",
  "info" : {
    "title" : "Test1"
   },
  "schemes" : [ "https" ],
  "basePath" : "/import",
  "x-amazon-apigateway-api-key-source" : "HEADER",
   .
   .
   .
}
OpenAPI 3.0.1
{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "Test1"
  },
  "servers" : [ {
    "url" : "/{basePath}",
    "variables" : {
      "basePath" : {
        "default" : "import"
      }
    }
  } ],
  "x-amazon-apigateway-api-key-source" : "HEADER",
   .
   .
   .
}