Tutorial: Erstellen einer REST-API mit einer privaten Integration - Amazon API Gateway
Schritt 1: Erstellen Sie einen Amazon-ECS-ServiceSchritt 2: Erstellen eines VPC-LinksSchritt 3: Erstellen Sie eine REST-APISchritt 4: Testen Sie Ihre APISchritt 5: Bereitstellen Ihrer APISchritt 6: Rufen Sie Ihre API aufSchritt 7: Bereinigen

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.

Tutorial: Erstellen einer REST-API mit einer privaten Integration

In diesem Tutorial erstellen Sie eine REST-API, die eine Verbindung zu einem Amazon ECS-Service herstellt, der in einer Amazon VPC ausgeführt wird. Clients außerhalb Ihrer Amazon VPC können die API verwenden, um auf Ihren Amazon-ECS-Service zuzugreifen.

Für dieses Tutorial brauchen Sie ungefähr eine Stunde. Zunächst verwenden Sie eine CloudFormation Vorlage, um einen Amazon VPC- und Amazon ECS-Service zu erstellen. Anschließend verwenden Sie die API Gateway Gateway-Konsole, um einen VPC-Link V2 zu erstellen. Der VPC-Link ermöglicht es API Gateway, auf den Amazon-ECS-Service zuzugreifen, der in Ihrer Amazon VPC ausgeführt wird. Als Nächstes erstellen Sie eine REST-API, die den VPC-Link V2 verwendet, um eine Verbindung zu Ihrem Amazon ECS-Service herzustellen. Zuletzt testen Sie Ihre API.

Wenn Sie Ihre REST-API aufrufen, leitet API Gateway die Anfrage über Ihren VPC-Link V2 an Ihren Amazon ECS-Service weiter und gibt dann die Antwort vom Service zurück.

Anmerkung

Dieses Tutorial wurde zuvor für HTTP APIs unterstützt und wird jetzt für REST APIs mithilfe von VPC Link V2 unterstützt.

Übersicht der REST-API, die Sie in diesem Tutorial erstellen.

Um dieses Tutorial abzuschließen, benötigen Sie ein AWS Konto und einen AWS Identity and Access Management Benutzer mit Konsolenzugriff. Weitere Informationen finden Sie unter Einrichten der API Gateway.

Schritt 1: Erstellen Sie einen Amazon-ECS-Service

Amazon ECS ist ein Container-Management-Service, mit dem Sie unkompliziert Docker-Container in einem Cluster ausführen, beenden und verwalten können. In diesem Tutorial führen Sie Ihren Cluster auf einer serverlosen Infrastruktur aus, die von Amazon ECS verwaltet wird.

Laden Sie diese CloudFormation Vorlage herunter und entpacken Sie sie, wodurch alle Abhängigkeiten für den Service, einschließlich einer Amazon VPC, erstellt werden. Sie verwenden die Vorlage, um einen Amazon-ECS-Service zu erstellen, der einen Application Load Balancer verwendet.

Um einen Stack zu erstellen CloudFormation

  1. Öffnen Sie die CloudFormation Konsole unter https://console.aws.amazon.com/cloudformation.

  2. Wählen Sie Stack erstellen und dann Mit neuen Ressourcen (Standard) aus.

  3. Wählen Sie unter Vorlage angeben die Option Vorlagendatei hochladen aus.

  4. Wählen Sie die Vorlage aus, die Sie heruntergeladen haben.

  5. Wählen Sie Weiter aus.

  6. Geben Sie für Stack-Name die Zeichenfolge rest-api-private-integrations-tutorial ein und klicken Sie auf Weiter.

  7. Wählen Sie in Stack-Optionen konfigurieren die Option Weiter aus.

  8. Bestätigen Sie bei Capabilities, dass IAM-Ressourcen in Ihrem Konto erstellt werden CloudFormation können.

  9. Wählen Sie Weiter und anschließend Absenden aus.

CloudFormation stellt den ECS-Service bereit, was einige Minuten dauern kann. Wenn der Status Ihres CloudFormation Stacks CREATE_COMPLETE lautet, können Sie mit dem nächsten Schritt fortfahren.

Ein VPC-Link ermöglicht es API Gateway, auf private Ressourcen in einer Amazon VPC zuzugreifen. Sie verwenden einen VPC-Link, um Kunden den Zugriff auf Ihren Amazon ECS-Service über Ihre REST-API zu ermöglichen.

So erstellen Sie einen VPC-Link

  1. Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

  2. Klicken Sie im Hauptnavigationsbereich auf VPC-Links und dann auf Erstellen.

    Sie müssen möglicherweise auf das Menüsymbol klicken, um den Hauptnavigationsbereich zu öffnen.

  3. Wählen Sie für Wählen Sie eine VPC-Link-Version die Option VPC-Link V2 aus.

  4. Geben Sie als Name die Zeichenfolge „private-integrations-tutorial“ ein.

  5. Wählen Sie für VPC die in Schritt 1 erstellte VPC aus. Der Name muss mit RestApiStack beginnen.

  6. Wählen Sie für Subnetze die beiden privaten Subnetze in Ihrer VPC aus. Ihre Namen enden mit PrivateSubnet.

  7. Wählen Sie unter Sicherheitsgruppen die Gruppen-ID aus, die mit private-integrations-tutorial beginnt und die RestApiStack/RestApiTutorialService/Service/SecurityGroup-Beschreibung enthält.

  8. Wählen Sie Erstellen aus.

Nachdem Sie Ihren VPC-Link V2 erstellt haben, stellt API Gateway Elastic Network Interfaces für den Zugriff auf Ihre VPC bereit. Der Vorgang kann einige Minuten dauern. In der Zwischenzeit können Sie Ihre API erstellen.

Schritt 3: Erstellen Sie eine REST-API

Die REST-API bietet einen HTTP-Endpunkt für Ihren Amazon ECS-Service.

So erstellen Sie eine REST-API

  1. Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

  2. Wählen Sie API erstellen und dann für Rest-API die Option Erstellen aus.

  3. Geben Sie unter Name private-integration-api ein.

  4. Wählen Sie als IP-Adresstyp die Option. IPv4

  5. Wählen Sie Create API (API erstellen) aus.

    Nachdem Sie Ihre API erstellt haben, erstellen Sie eine Methode.

  6. Wählen Sie Methode erstellen aus und gehen Sie dann wie folgt vor:

    1. Wählen Sie als Methodentyp die Option GET aus.

    2. Für Integrationstyp wählen Sie VPC-Link aus.

    3. Aktivieren Sie die Lambda-Proxy-Integration.

    4. Für HTTP-Methode wählen Sie GET aus.

    5. Wählen Sie für VPC-Link den VPC-Link V2 aus, den Sie im vorherigen Schritt erstellt haben.

    6. Geben Sie als Integrationsziel den Load Balancer ein, den Sie mit der CloudFormation Vorlage in Schritt 1 erstellt haben. Sein Name sollte mit rest- beginnen.

    7. Geben Sie für Endpunkt-URL http://private-integrations-tutorial.com ein.

      Die URL wird verwendet, um den Host Header der Integrationsanfrage festzulegen. In diesem Fall ist der Host-Headerprivate-integrations-tutorial.

    8. Wählen Sie Methode erstellen aus.

      Mit der Proxy-Integration ist die API bereit zum Testen.

Schritt 4: Testen Sie Ihre API

Als Nächstes testen Sie den Aufruf der API-Methode.

So testen Sie Ihre API

  1. Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

  2. Wählen Sie Ihre API aus.

  3. Wählen Sie die Registerkarte Test. Möglicherweise müssen Sie die rechte Pfeiltaste wählen, um die Registerkarte anzuzeigen.

  4. Wählen Sie Test

    Stellen Sie sicher, dass die Antwort Ihrer API eine Willkommensnachricht ist, die Ihnen mitteilt, dass Ihre App auf Amazon ECS ausgeführt wird.

Schritt 5: Bereitstellen Ihrer API

Als Nächstes stellen Sie Ihre API bereit.

Stellen Sie Ihre API bereit

  1. Klicken Sie auf Deploy API.

  2. Wählen Sie für Stufe die Option Neue Stufe aus.

  3. Geben Sie für Stage name (Stufenname) Prod ein.

  4. (Optional) Geben Sie unter Description (Beschreibung) eine Beschreibung ein.

  5. Wählen Sie Bereitstellen.

Schritt 6: Rufen Sie Ihre API auf

Nachdem Ihre API bereitgestellt wurde, können Sie sie aufrufen.

Um Ihre API aufzurufen

  1. Geben Sie die Aufruf-URL in einen Webbrowser ein.

    Die URL sollte wie folgt aussehen: https://abcd123.execute-api.us-east-2.amazonaws.com/Prod.

    Ihr Browser sendet eine GET-Anforderung an die API.

  2. Stellen Sie sicher, dass die Antwort Ihrer API eine Willkommensnachricht ist, die Ihnen mitteilt, dass Ihre App auf Amazon ECS ausgeführt wird.

    Wenn Sie die Willkommensnachricht sehen, haben Sie erfolgreich einen Amazon ECS-Service erstellt, der in einer Amazon VPC ausgeführt wird, und Sie haben eine API-Gateway-REST-API mit einem VPC-Link V2 verwendet, um auf den Amazon ECS-Service zuzugreifen.

Schritt 7: Bereinigen

Um unnötige Kosten zu verhindern, löschen Sie die Ressourcen, die Sie im Rahmen dieses Tutorials erstellt haben. Mit den folgenden Schritten werden Ihr VPC-Link V2, Ihr CloudFormation Stack und Ihre REST-API gelöscht.

So löschen Sie eine REST-API

  1. Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

  2. Wählen Sie auf der APIsSeite eine API aus. Wählen Sie Aktionen, wählen Sie Löschenund bestätigen Sie dann Ihre Auswahl.

So löschen Sie einen VPC-Link

  1. Melden Sie sich bei der API Gateway Gateway-Konsole unter https://console.aws.amazon.com/apigatewayan.

  2. Wählen Sie VPC-Link.

  3. Wählen Sie Ihren VPC-Link aus, wählen Sie Löschen und bestätigen Sie dann Ihre Auswahl.

Um einen Stapel zu löschen CloudFormation

  1. Öffnen Sie die CloudFormation Konsole unter https://console.aws.amazon.com/cloudformation.

  2. Wählen Sie Ihren CloudFormation Stack aus.

  3. Wählen Sie Löschen und bestätigen Sie dann Ihre Auswahl.