x-amazon-apigateway-apiEigenschaft -key-source - APIAmazon-Gateway
x-amazon-apigateway-apiBeispiel für -key-source

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

x-amazon-apigateway-apiEigenschaft -key-source

Geben Sie die Quelle an, die einen API Schlüssel erhalten soll, um API Methoden zu drosseln, für die ein Schlüssel erforderlich ist. Diese Eigenschaft API auf der Ebene -Ebene ist ein String Typ. Weitere Hinweise zur Konfiguration einer Methode, für die ein API Schlüssel erforderlich ist, finden Sie unterKonfigurieren Sie eine Methode zur Verwendung von API Schlüsseln mit einer API Open-Definition.

Geben Sie die Quelle des API Schlüssels für Anfragen an. Gültige Werte für sind:

  • HEADERzum Empfangen des API Schlüssels aus dem X-API-Key Header einer Anfrage.

  • AUTHORIZERfür den Empfang des API Schlüssels UsageIdentifierKey von einem Lambda-Autorisierer (früher bekannt als benutzerdefinierter Autorisierer).

x-amazon-apigateway-apiBeispiel für -key-source

Im folgenden Beispiel wird der X-API-Key Header als Schlüsselquelle festgelegt. 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",
   .
   .
   .
}