Modul 4. Bereitstellen einer RESTful-API

In diesem Modul verwenden Sie Amazon API Gateway zur Bereitstellung der Lambda-Funktion, die Sie im vorherigen Modul als RESTful-API erstellt haben. Die statische Website, die Sie im nächsten Modul hosten werden, verfügt über eine konfigurierte Seite zur Interaktion mit der von Ihnen in diesem Modul erstellten API.

Anpassen der SENDER-Adresse, die für die E-Mail-Kommunikation mit Ihren Benutzern verwendet wird

Erstellen eines serverlosen Backends

Erstellen einer Zustandsmaschine

Bereitstellen einer RESTful-API

Hosten einer statischen Website

Testen der Konfiguration

Implementierungsanweisungen

Befolgen Sie die folgende schrittweise Anleitung zur Erstellung Ihrer REST-API. Klicken Sie auf die Nummer eines jeweiligen Schritts, um den Bereich zu erweitern.

  • Schritt 1: Erstellen einer neuen RESTful-API

    Mit Amazon API Gateway können Sie Ihre eigenen REST- und WebSocket API-Vorgänge erstellen, veröffentlichen, verwalten, überwachen und sichern. Befolgen Sie die folgenden Schritte zur Erstellung einer neuen RESTful API.

    1. Öffnen Sie die Amazon API Gateway-Konsole unter https://console.aws.amazon.com/apigateway.
    2. Führen Sie eine der folgenden Aufgaben aus:
      • Wenn dies Ihre erste API-Aktion ist, wird die Seite Get Started (Erste Schritte) angezeigt. Wählen Sie Get Started (Erste Schritte).
      • Wählen Sie im Dialogfeld Create Example API (Beispiel-API erstellen) die Option OK.
      • Wenn dies nicht Ihre erste API-Aktion ist, wählen Sie Create API (API erstellen).
    3. Wählen Sie unter Choose an API type (API-Typ auswählen) die Option REST API und dann Build (Erstellen).
    4. Behalten Sie unter Choose the protocol (Protokoll auswählen) die Auswahl REST bei.
    5. Behalten Sie unter Create new API (Neue API erstellen) die Auswahl NEW API (NEUE API) bei.
    6. Führen Sie die folgenden Schritte in Settings (Einstellungen) aus:
      • Geben Sie als API name (API-Name) examplecorp_eao ein.
      • Unter Description (Beschreibung) können Sie optional eine Beschreibung eingeben.
      • Behalten Sie unter Endpoint Type (Endpunkttyp) die Auswahl Regional bei.
    7. Wählen Sie Create API (API erstellen) aus.

  • Schritt 2: Konfigurieren von API Gateway zur Integration der Lambda-Funktion

    Führen Sie die folgenden Schritte aus, um API Gateway für diesen Workshop zu konfigurieren.

    1. Öffnen Sie die Amazon API Gateway-Konsole unter https://console.aws.amazon.com/apigateway.
    2. Wählen Sie im Navigationsbereich unter examplecorp_eao API die Option Resources (Ressourcen) aus.
    3. Wählen Sie Actions, Create Resource (Aktionen, Ressource erstellen) aus.
    4. Führen Sie die folgenden Schritte aus:
      • Geben Sie als Resource name (Ressourcename) execute ein.
      • Stellen Sie sicher, dass der Resource Path (Ressourcenpfad) auf /execute festgelegt ist.
      • Aktivieren Sie das Kontrollkästchen Enable API Gateway CORS (API Gateway CORS aktivieren).
      • Lassen Sie das Kontrollkästchen Configure as proxy resource (Als Proxy-Ressource konfigurieren) deaktiviert.
    5. Wählen Sie Create Resource (Ressource erstellen).
    6. Wenn Ihre neu erstellte Ressource (/execute) im Bereich Resources (Ressourcen) ausgewählt ist, wählen Sie Actions (Aktionen) und dann die Option Create Methode (Methode erstellen).
    7. Wählen Sie unterOPTIONS (OPTIONEN) die Option POST und aktivieren Sie das Kontrollkästchen rechts neben der Liste.
    8. Führen Sie im Bereich POST – Setup (POST – Einrichtung) die folgenden Schritte aus:
      • Wählen Sie als Integration type (Integrationstyp) die Option AWS Service aus.
      • Wählen Sie als AWS Region Ihre Region aus.
      • Wählen Sie als AWS Service die Option Step Functions (Stufenfunktionen) aus.
      • Lassen Sie die AWS Subdomain frei.
      • Wählen Sie als HTTP-Methode die Option POST aus.
      • Behalten Sie unter Action Type (Aktionstyp) die Auswahl Use action name (Aktionsname verwenden) bei.
      • Geben Sie unter Action (Aktion) StartExecution ein.
      • Kopieren Sie für die Execution Role (Ausführungsrolle) die Rolle ARN der zuvor erstellten IAM-Service-verknüpften Rolle examplecorp_eao_role und fügen Sie sie ein.
      • Behalten Sie für Content Handling (Inhaltsverarbeitung) die Auswahl Passthrough bei.
      • Stellen Sie sicher, dass das Kontrollkästchen unter Use Default Timeout (Standard-Timeout verwenden) aktiviert ist.
      • Wählen Sie Save (Speichern).
    9.  Wenn Ihre neu erstellte Methode (POST) im Bereich Resources (Ressourcen) ausgewählt ist, wählen Sie Actions (Aktionen) und dann die Option Enable CORS (CORS aktivieren).
    10. Behalten Sie im Bereich Enable CORS (CORS aktivieren) die Standardwerte bei und wählen Sie Enable CORS and replace existing CORS headers (CORS aktivieren und bestehende CORS-Header ersetzen) aus.
    11. Wählen Sie im Dialogfeld zur Bestätigung der Methodenänderung Yes, replace existing values (Ja, bestehende Werte ersetzen) aus.
    12. Eine Meldung informiert Sie darüber, dass Ihre Ressource für CORS konfiguriert wurde.
    13. Wählen Sie im Bereich Resources (Ressourcen) die Option POST.
    14. Wählen Sie Actions, Deploy API (Aktionen, API bereitstellen).
    15. Führen Sie im Dialogfeld Deploy API (API bereitstellen) die folgenden Schritte aus:
      • Wählen Sie als Deployment stage (Bereitstellungsstufe) die Option [New Stage] (Neue Stufe) aus.
      • Geben Sie als Stage name (Stufenname) test ein.
      • Unter Stage description (Stufenbeschreibung) und Deployment description (Bereitstellungsbeschreibung) können Sie optional eine Beschreibung eingeben.
      • Wählen Sie Deploy (Bereitstellen) aus.
    16. Erweitern Sie im Bereich Stages (Stufen) Ihre neu erstellte Stufe test.
    17. Wählen Sie POST aus.
    18. Oben im Bereich Stage Editor wird die Invoke URL (Aufruf-URL) angezeigt. Notieren Sie sich diese URL. Sie benötigen diese URL im späteren Verlauf des Projektes.
Zurück zur Einführung
Nächster Schritt: Hosten einer statischen Website