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.

Die folgenden Verfahren beschreiben, wie Sie die API Gateway Gateway-Konsole verwenden, um eine Integrationsanfrage zu erstellen.

Eine Lambda-Integration einrichten

Verwenden Sie eine Lambda-Funktionsintegration, um Ihre API in eine Lambda-Funktion zu integrieren. 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.

So richten Sie eine Lambda-Integration ein

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. Für Integration type (Integrationstyp) wählen Sie Lambda Function (Lambda-Funktion) aus.

4. 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.

5. 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.

6. 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.

7. (Optional) Sie können die Einstellungen für die Methodenanforderung mithilfe der folgenden Dropdownmenüs konfigurieren. Wählen Sie Einstellungen für Methodenanfragen und konfigurieren Sie Ihre Methodenanforderung. Weitere Informationen finden Sie in Schritt 3 vonBearbeiten Sie eine API Gateway Gateway-Methodenanforderung in der API Gateway Gateway-Konsole.

   Sie können Ihre Einstellungen für Methodenanfragen auch konfigurieren, nachdem Sie Ihre Methode erstellt haben.

8. Wählen Sie Methode erstellen aus.

Richten Sie eine HTTP-Integration ein

Verwenden Sie eine HTTP-Integration, um Ihre API in einen HTTP-Endpunkt zu integrieren. Auf der API-Ebene ist dies der HTTP Integrationstyp.

Um eine HTTP-Integration einzurichten

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 als Integrationstyp HTTP aus.

4. 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.

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

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

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

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. (Optional) Sie können die Einstellungen für die Methodenanforderung mithilfe der folgenden Dropdownmenüs konfigurieren. Wählen Sie Einstellungen für Methodenanfragen und konfigurieren Sie Ihre Methodenanforderung. Weitere Informationen finden Sie in Schritt 3 vonBearbeiten Sie eine API Gateway Gateway-Methodenanforderung in der API Gateway Gateway-Konsole.

   Sie können Ihre Einstellungen für Methodenanfragen auch konfigurieren, nachdem Sie Ihre Methode erstellt haben.

10. Wählen Sie Methode erstellen aus.

Richten Sie eine AWS Serviceintegration ein

Verwenden Sie eine AWS Serviceintegration, um Ihre API direkt in einen AWS Dienst zu integrieren. Auf der API-Ebene ist dies der AWS Integrationstyp.

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.

Um eine AWS Serviceintegration einzurichten

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 als Integrationstyp die Option AWS Service aus.

4. Wählen Sie für AWS Region die AWS Region aus, die diese Methode zum Aufrufen der Aktion verwenden soll.

5. Wählen Sie für AWS Service den AWS Dienst aus, den Sie mit dieser Methode aufrufen möchten.

6. Geben Sie für AWS Subdomain die Subdomain ein, die AWS vom Service verwendet wird. 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.

7. Wählen Sie als HTTP method die der Aktion entsprechende HTTP-Methode aus. Informationen zum HTTP-Methodentyp finden Sie in der API-Referenzdokumentation für den AWS Dienst, den Sie für den Dienst ausgewählt haben.AWS

8. 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. Verfügbare Aktionen und benutzerdefinierte Ressourcenpfade finden Sie in der API-Referenzdokumentation für den AWS Dienst, den Sie für den AWS Dienst ausgewählt haben.

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

10. 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 Sie die AWS Service-Proxy-Ausführungsrolle 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"
          ]
        },
        ...
      ]
    }  

    Die Syntax der Aktions- und Ressourcenanweisungen finden Sie in der Dokumentation des AWS Dienstes, den Sie für den AWS Dienst ausgewählt haben.

    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"
        }
      ]
    }

11. 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.

12. (Optional) Sie können die Einstellungen für die Methodenanforderung mithilfe der folgenden Dropdownmenüs konfigurieren. Wählen Sie Einstellungen für Methodenanfragen und konfigurieren Sie Ihre Methodenanforderung. Weitere Informationen finden Sie in Schritt 3 vonBearbeiten Sie eine API Gateway Gateway-Methodenanforderung in der API Gateway Gateway-Konsole.

    Sie können Ihre Einstellungen für Methodenanfragen auch konfigurieren, nachdem Sie Ihre Methode erstellt haben.

13. Wählen Sie Methode erstellen aus.

Richten Sie eine Scheinintegration ein

Verwenden Sie eine Scheinintegration, wenn Sie möchten, dass API Gateway als Ihr Backend fungiert, 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.

Um eine Scheinintegration einzurichten

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 als Integrationstyp die Option Mock aus.

4. (Optional) Sie können die Einstellungen für die Methodenanforderung mithilfe der folgenden Dropdownmenüs konfigurieren. Wählen Sie Einstellungen für Methodenanfragen und konfigurieren Sie Ihre Methodenanforderung. Weitere Informationen finden Sie in Schritt 3 vonBearbeiten Sie eine API Gateway Gateway-Methodenanforderung in der API Gateway Gateway-Konsole.

   Sie können Ihre Einstellungen für Methodenanfragen auch konfigurieren, nachdem Sie Ihre Methode erstellt haben.

5. Wählen Sie Methode erstellen aus.