View a markdown version of this page

x-amazon-apigateway-api-key-source-Eigenschaft - Amazon API Gateway
x-amazon-apigateway-api-key-source-Beispiel

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-api-key-source-Eigenschaft

Geben Sie die Quelle eines API-Schlüssels an, um die API-Methoden, die einen Schlüssel fordern, zu drosseln. Diese API-level Eigenschaft ist ein String Typ. Weitere Informationen zur Methodenkonfigurierung für eine API-Schlüsselabfrage finden Sie unter Konfigurieren einer Methode zur Verwendung von API-Schlüsseln mit einer OpenAPI-Definition.

Geben Sie die Quelle des API-Schlüssels für Anforderungen an. Folgende Werte sind zulässig:

  • HEADER für den Empfang des API-Schlüssels aus dem X-API-Key-Header einer Anforderung.

  • AUTHORIZER für den Empfang des API-Schlüssels von UsageIdentifierKey von einem Lambda Genehmiger (ehemals als benutzerdefinierter Genehmiger bezeichnet).

x-amazon-apigateway-api-key-source-Beispiel

Im folgenden Beispiel wird der X-API-Key-Header als Quelle des API-Schlüssels festgelegt.

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