API-Integrationsanfrage über die API Gateway-Konsole einrichten - Amazon API Gateway

API-Integrationsanfrage über die API Gateway-Konsole einrichten

Die Einrichtung einer API-Methode definiert die Methode und beschreibt ihr Verhalten. Um eine Methode einzurichten, müssen Sie Folgendes angeben: eine Ressource, einschließlich des Roots (GET/POST), auf der die Methode bereitgestellt wird, eine HTTP-Methode (GET, POST usw.) und wie diese in das Ziel-Backend integriert wird. Die Methodenanforderung und -antwort geben die Regeln für den Austausch mit der aufrufenden App vor. Sie legen fest, welche Parameter die API empfangen kann und wie die Antwort aussieht.

Im folgenden Verfahren wird beschrieben, wie die API Gateway-Konsole zum Festlegen von Methodeneinstellungen verwendet wird.

  1. Wählen Sie im Bereich Resources die Methode aus.

  2. Wählen Sie im Bereich Method Execution die Option Integration Request. Wählen Sie für Integration type eine der folgenden Optionen:

    • Wählen Sie Lambda Function (Lambda-Funktion) aus, wenn Ihre API mit einer Lambda-Funktion integriert werden soll. Auf der API-Ebene ist dies ein AWS Integrationstyp.

    • Wählen Sie HTTP, wenn Ihre API in einen HTTP-Endpunkt integriert wird. Auf der API-Ebene ist dies der HTTP Integrationstyp.

    • Wählen Sie AWS Service, wenn Ihre API direkt in einen AWS-Service integriert wird. Auf der API-Ebene ist dies der AWS Integrationstyp. Die obige Option Lambda-Funktion ist ein Sonderfall der AWS-Integration für den Aufruf einer Lambda-Funktion und ist nur in der API-Gateway-Konsole verfügbar. Um eine API-Gateway-API für die Erstellung einer neuen Lambda-Funktion in AWS Lambda, das Festlegen einer Ressourcenberechtigung für die Lambda-Funktion oder die Durchführung anderer Lambda-Service-Aktionen einzurichten, müssen Sie hier die Option AWS-Service auswählen.

    • Wählen Sie Mock aus, wenn API Gateway als Backend fungieren soll, um statische Antworten zurückzugeben. Auf der API-Ebene ist dies der MOCK Integrationstyp. Normalerweise können Sie die MOCK Integration verwenden, wenn Ihre API noch nicht finalisiert ist, Sie aber API-Antworten erzeugen möchten, um abhängigen Teams Tests zu ermöglichen. Für die OPTION-Methode legt API Gateway die MOCK-Integration als Standard fest, um CORS-fähige Header für die angewandte API-Ressource zurückzugeben. Wenn Sie diese Option auswählen, überspringen Sie die restlichen Anweisungen in diesem Thema und lesen Sie die Informationen unter Mock-Integrationen in API Gateway einrichten.

  3. Wenn Sie Lambda Function (Lambda-Funktion) wählen, gehen Sie wie folgt vor:

    1. Wählen Sie für Lambda Region die Regions-ID, die der Region entspricht, in der Sie die Lambda-Funktion erstellt haben. Wenn Sie zum Beispiel die Lambda-Funktion in der Region US East (N. Virginia) erstellt haben, wählen Sie us-east-1. Eine Liste der Namen und IDs der Regionen finden Sie unter AWS Lambda in der Allgemeinen Referenz zu Amazon Web Services.

    2. Geben Sie für Lambda Function (Lambda-Funktion) den Namen der Lambda-Funktion ein und wählen Sie dann den ARN der Funktion aus.

    3. Wählen Sie Save (Speichern) aus.

  4. Wenn Sie HTTP ausgewählt haben, gehen Sie wie folgt vor:

    1. Wählen Sie als HTTP method die HTTP-Methode aus, die am ehesten der Methode im HTTP-Backend entspricht.

    2. Geben Sie als Endpoint URL die URL des HTTP-Backends ein, das diese Methode verwenden soll.

    3. Wählen Sie Save (Speichern) aus.

  5. Wenn Sie Mock ausgewählt haben, gehen Sie wie folgt vor:

    1. Wählen Sie Save (Speichern) aus.

  6. Wenn Sie AWSService ausgewählt haben, gehen Sie wie folgt vor:

    1. Wählen Sie als AWS Region die AWS-Region aus, die diese Methode verwenden soll, um die Aktion aufzurufen.

    2. Wählen Sie als AWSService den AWS-Service aus, den diese Methode aufrufen soll.

    3. Geben Sie für AWS Subdomain die Subdomain ein, die der AWS-Service benutzt. Normalerweise bleibt dieses Feld leer. Einige AWS-Services können Subdomänen als Teil des Hosts unterstützen. Weitere Informationen über die Verfügbarkeit und gegebenenfalls Details finden Sie in der Service-Dokumentation.

    4. Wählen Sie als HTTP method die der Aktion entsprechende HTTP-Methode aus. Informationen zum HTTP-Methodentyp finden Sie in der API-Referenzdokumentation zu dem AWS-Service, den Sie unter AWS Service ausgewählt haben.

    5. Geben Sie unter Action die Aktion ein, die Sie verwenden möchten. Eine Liste der verfügbaren Aktionen finden Sie in der API-Referenzdokumentation zu dem AWS-Service, den Sie unter AWS Service ausgewählt haben.

    6. Geben Sie unter Execution Role den ARN der IAM-Rolle ein, die die Methode zum Aufrufen der Aktion verwendet.

      Um die IAM-Rolle zu erstellen, können Sie die Anweisungen unter "So erstellen Sie die Lambda-Aufrufrolle und ihre Richtlinien" und "So erstellen Sie die Lambda-Ausführungsrolle und ihre Richtlinien" im Abschnitt Lambda-Funktionen erstellen verwenden. Legen Sie eine Zugriffsrichtlinie mit der gewünschten Anzahl an Aktions- und Ressourcenanweisungen im folgenden Format fest:

      {
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "action-statement"
      ],
      "Resource": [
        "resource-statement"
      ]
    },
    ...
  ]
}

      Informationen zur Syntax für die Aktions- und Ressourcenanweisungen finden Sie in der Dokumentation zu dem unter AWS-Service ausgewählten AWS-Service.

      Für die Vertrauensbeziehung der IAM-Rolle geben Sie Folgendes an, wodurch API Gateway in der Lage ist, im Namen Ihres AWS-Kontos aktiv zu werden:

      {
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "",
      "Effect": "Allow",
      "Principal": {
        "Service": "apigateway.amazonaws.com"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

    7. Wenn die unter Action eingegebene Aktion einen benutzerdefinierten Ressourcenpfad bereitstellt, den diese Methode verwenden soll, geben Sie unter Path Override den benutzerdefinierten Ressourcenpfad ein. Informationen zu dem benutzerdefinierten Ressourcenpfad finden Sie in der API-Referenzdokumentation zu dem AWS-Service, den Sie unter AWSService ausgewählt haben.

    8. Wählen Sie Save (Speichern) aus.