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

Spécifiez la source qui recevra une clé API pour limiter les méthodes d'API qui requièrent une clé. Cette propriété d'API est de type String. Pour plus d'informations sur la configuration d'une méthode nécessitant une clé d'API, consultezConfiguration d'une méthode pour utiliser des clés d'API avec une définition OpenAPI.

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

• HEADER pour recevoir la clé API à partir de l'en-tête X-API-Key d'une demande.

• AUTHORIZER pour la réception de la clé d'API à partir de l'élément UsageIdentifierKey à partir d'un mécanisme d'autorisation Lambda (anciennement appelé Custom Authorizer (mécanisme d'autorisation personnalisé)).

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

L'exemple suivant définit l'en-tête X-API-Key en tant que source de clé 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",
   .
   .
   .
}