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

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.

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 (Ressourcen) die Option Create method (Methode erstellen) aus.

  2. Wählen Sie als Method type (Methodentyp) eine HTTP-Methode aus.

  3. Wählen Sie für Integration type (Integrationstyp) eine der folgenden Optionen:

    • Wählen Sie Lambda Function (Lambda-Funktion) aus, wenn Ihre API mit einer Lambda-Funktion integriert werden soll. Auf API-Ebene ist dies ein AWS-Integrationstyp, wenn Sie eine Nicht-Proxy-Integration erstellen, oder ein AWS_PROXY-Integrationstyp, wenn Sie eine Proxy-Integration erstellen.

    • 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 function (Lambda-Funktion) ist ein Sonderfall der AWS-Integration für den Aufruf einer Lambda-Funktion.

      Gehen Sie zum Einrichten einer API Gateway wie folgt vor:

      • Erstellen Sie eine neue Lambda-Funktion.

      • Legen Sie eine Ressourcenberechtigung für die Lambda-Funktion fest.

      • Führen Sie alle anderen Lambda-Serviceaktionen aus.

      Sie müssen den AWS-Service wä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.

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

    1. Um eine Lambda-Proxyintegration zu verwenden, aktivieren Sie Lambda proxy integration (Lambda-Proxyintegration). Weitere Informationen zum Erstellen von Lambda-Proxy-Integrationen finden Sie unter API Gateway Lambda-Proxy-Integration kennenlernen.

    2. Geben Sie für Lambda function (Lambda-Funktion) den Namen der Funktion ein. Wenn Sie eine Lambda-Funktion in einer anderen Region als Ihrer API verwenden, wählen Sie die Region aus dem Dropdownmenü aus und geben Sie den Namen der Lambda-Funktion ein. Wenn Sie eine kontoübergreifende Lambda-Funktion verwenden, geben Sie die Funktion ARN ein.

      Eine Liste der Namen und IDs der Regionen finden Sie unter AWS Lambda in der Allgemeinen Referenz zu Amazon Web Services.

    3. Wenn Sie die Standardzeitüberschreitung von 29 Sekunden verwenden möchten, lassen Sie das Kontrollkästchen Default timeout (Standardzeitüberschreitung) aktiviert. Wenn Sie einen benutzerdefinierten Zeitüberschreitungswert festlegen möchten, wählen Sie Default timeout (Standardzeitüberschreitung) aus und geben Sie einen Zeitüberschreitungswert zwischen 50 und 29000 Millisekunden ein.

    4. Wählen Sie Methode erstellen aus.

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

    1. Um eine HTTP-Proxyintegration zu verwenden, aktivieren Sie HTTP proxy integration (HTTP-Proxyintegration). Weitere Informationen zu HTTP-Proxyintegrationen finden Sie unter HTTP-Proxy-Integrationen in API Gateway einrichten.

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

    3. Geben Sie als Endpoint URL (Endpunkt-URL) die URL des HTTP-Backends ein, das diese Methode verwenden soll.

    4. Wählen Sie für Content handling (Inhaltsbehandlung) ein Verhalten bei der Inhaltsbehandlung aus.

    5. Wenn Sie die Standardzeitüberschreitung von 29 Sekunden verwenden möchten, lassen Sie das Kontrollkästchen Default timeout (Standardzeitüberschreitung) aktiviert. Wenn Sie einen benutzerdefinierten Zeitüberschreitungswert festlegen möchten, wählen Sie Default timeout (Standardzeitüberschreitung) aus und geben Sie einen Zeitüberschreitungswert zwischen 50 und 29000 Millisekunden ein.

    6. Wählen Sie Methode erstellen aus.

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

    1. Wählen Sie Methode erstellen aus.

  7. Wenn Sie AWS-Service 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 AWS-Service 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. Wählen Sie unter Action type (Aktionstyp) entweder Use action name (Aktionsnamen verwenden) aus, um eine API-Aktion zu verwenden, oder Use path override (Pfadüberschreibung verwenden), um einen benutzerdefinierten Ressourcenpfad zu verwenden. Informationen zu den verfügbaren Aktionen und benutzerdefinierten Ressourcenpfaden finden Sie in der API-Referenzdokumentation zu dem AWS-Service, den Sie unter AWS-Service ausgewählt haben.

    6. Geben Sie entweder einen Action name (Aktionsnamen) oder eine Path override (Pfadüberschreibung) ein.

    7. Geben Sie unter Execution Role (Ausführungsrolle) den ARN der IAM-Rolle ein, die die Methode zum Aufrufen der Aktion verwendet.

      Zum Erstellen einer IAM-Rolle können Sie die Anweisungen in Schritt 1: Erstellen der Ausführungsrolle für den AWS-Service-Proxy anpassen. 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"
    }
  ]
}

    8. Wenn Sie die Standardzeitüberschreitung von 29 Sekunden verwenden möchten, lassen Sie das Kontrollkästchen Default timeout (Standardzeitüberschreitung) aktiviert. Wenn Sie einen benutzerdefinierten Zeitüberschreitungswert festlegen möchten, wählen Sie Default timeout (Standardzeitüberschreitung) aus und geben Sie einen Zeitüberschreitungswert zwischen 50 und 29000 Millisekunden ein.

    9. Wählen Sie Methode erstellen aus.