Propiedad x-amazon-apigateway-api-key-source

Especifique el origen del que va a provenir la clave de la API para limitar los métodos de API que solicitan claves. Esta propiedad de nivel de API es de tipo String. Para obtener más información sobre cómo configurar un método para exigir una clave de API, consulte Configuración de un método para usar claves de API con una definición de OpenAPI.

Especifique el origen de la clave de la API en las solicitudes. Los valores válidos son:

• HEADER para recibir la clave de la API desde el encabezado X-API-Key de una solicitud.

• AUTHORIZER para recibir la clave de la API de UsageIdentifierKey desde un autorizador de Lambda (que anteriormente se denominaba autorizador personalizado).

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

En el siguiente ejemplo, el encabezado X-API-Key se establece como origen de las claves de la 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",
   .
   .
   .
}