x-amazon-apigateway-apipropriété -key-source - APIPasserelle Amazon
x-amazon-apigateway-apiexemple de -key-source

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

x-amazon-apigateway-apipropriété -key-source

Spécifiez la source qui recevra une API clé pour limiter les API méthodes qui nécessitent une clé. Cette propriété API de niveau est un String type. Pour plus d'informations sur la configuration d'une méthode nécessitant une API clé, consultezConfigurer une méthode pour utiliser API des clés avec une API définition ouverte.

Spécifiez la source de la API clé pour les demandes. Les valeurs valides sont :

  • HEADERpour recevoir la API clé depuis l'X-API-Keyen-tête d'une demande.

  • AUTHORIZERpour avoir reçu la API clé UsageIdentifierKey d'un autorisateur Lambda (anciennement connu sous le nom d'autorisateur personnalisé).

x-amazon-apigateway-apiexemple de -key-source

L'exemple suivant définit l'X-API-Keyen-tête comme source API clé.

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",
   .
   .
   .
}