Erste Schritte mit API Gateway

Anmerkung

Die neu gestaltete API-Gateway-Konsole ist jetzt verfügbar. Ein Tutorial zur Verwendung der Konsole zum Erstellen einer REST-API finden Sie unter Erste Schritte mit der REST-API-Konsole.

Bei dieser Übung „Erste Schritte“ erstellen Sie eine Serverless-API. Mit Serverless-APIs können Sie sich auf Ihre Anwendungen konzentrieren, anstatt Zeit mit der Bereitstellung und Verwaltung von Servern zu verbringen. Diese Übung dauert weniger als 20 Minuten und kann im Rahmen des AWSkostenlosen Kontingents durchgeführt werden.

Zuerst erstellen Sie mithilfe der AWS Lambda-Konsole eine Lambda-Funktion. Als Nächstes erstellen Sie eine HTTP-API mit der API-Gateway-Konsole. Dann rufen Sie Ihre API auf.

Anmerkung

In dieser Übung wird zur Vereinfachung eine HTTP-API verwendet. API-Gateway unterstützt auch REST-APIs, die mehr Funktionen enthalten. Weitere Informationen hierzu finden Sie unter Auswahl zwischen REST-APIs und HTTP-APIs.

Wenn Sie Ihre HTTP-API aufrufen, leitet API Gateway die Anfrage an Ihre Lambda-Funktion weiter. Lambda führt die Lambda-Funktion aus und gibt eine Antwort an API Gateway zurück. API Gateway gibt dann eine Antwort an Sie zurück.

Um diese Übung abzuschließen, benötigen Sie ein AWS-Konto und einen AWS Identity and Access Management-Benutzer mit Konsolenzugriff. Weitere Informationen finden Sie unter Voraussetzungen für die ersten Schritte mit API Gateway.

Schritt 1: Erstellen einer Lambda-Funktion

Sie verwenden eine Lambda-Funktion für das Backend Ihrer API. Lambda führt Ihren Code nur bei Bedarf aus und skaliert automatisch – von einigen Anforderungen pro Tag bis zu Tausenden pro Sekunde.

In diesem Beispiel verwenden Sie die Standardfunktion Node.js von der Lambda-Konsole aus.

So erstellen Sie eine Lambda-Funktion:

1. Melden Sie sich bei der Lambda-Konsole unter https://console.aws.amazon.com/lambda an.

2. Wählen Sie Create function (Funktion erstellen).

3. Geben Sie für Function name (Funktionsname) my-function ein.

4. Wählen Sie Create function (Funktion erstellen).

Die Beispielfunktion gibt eine 200-Antwort an Clients und den Text Hello from Lambda! zurück.

Sie können Ihre Lambda-Funktion ändern, solange die Antwort der Funktion mit dem Format übereinstimmt, das API Gateway benötigt.

Der standardmäßige Lambda-Funktionscode sollte wie folgt aussehen:

export const handler = async (event) => {
    const response = {
        statusCode: 200,
        body: JSON.stringify('Hello from Lambda!'),
    };
    return response;
};

Schritt 2: HTTP-API erstellen

Als Nächstes erstellen Sie eine HTTP-API. API Gateway unterstützt auch REST-APIs und WebSocket-APIs, aber eine HTTP-API ist die beste Wahl für diese Übung. REST-APIs unterstützen mehr Funktionen als HTTP-APIs, aber wir benötigen diese Funktionen für diese Übung nicht. HTTP-APIs sind mit minimalen Funktionen ausgestattet, so dass sie zu einem niedrigeren Preis angeboten werden können. WebSocket-APIs unterhalten dauerhafte Verbindungen mit Clients für die Vollduplex-Kommunikation, was für dieses Beispiel nicht erforderlich ist.

Die HTTP-API bietet einen HTTP-Endpunkt für Ihre Lambda-Funktion. API Gateway leitet Anfragen an Ihre Lambda-Funktion weiter und gibt dann die Antwort der Funktion an Clients zurück.

So erstellen Sie eine HTTP-API

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

2. Führen Sie eine der folgenden Aufgaben aus:

   • Um Ihre erste API für HTTP-API zu erstellen, wählen Sie Build (Erstellen).

   • Wenn Sie zuvor eine API erstellt haben, wählen Sie Create API (API erstellen) und dann für HTTP APIBuild (Erstellen).

3. Wählen Sie für Integrations (Integrationen) die Option Add integration (Integration hinzufügen) aus.

4. Wählen Sie Lambda.

5. Geben Sie für die Lambda function (Lambda-Funktion) my-function ein.

6. Geben Sie in API name (API-Name) my-http-api ein.

7. Wählen Sie Next.

8. Überprüfen Sie die Route, die API Gateway für Sie erstellt, und wählen Sie dann Next (Weiter).

9. Überprüfen Sie die Phase , die API Gateway für Sie erstellt, und wählen Sie dann Next (Weiter).

10. Wählen Sie Create aus.

Jetzt haben Sie eine HTTP-API mit einer Lambda-Integration erstellt, die bereit ist, Anfragen von Clients zu erhalten.

Schritt 3: Ihre API testen

Als Nächstes testen Sie Ihre API, um sicherzustellen, dass sie funktioniert. Verwenden Sie zur Vereinfachung einen Webbrowser, um Ihre API aufzurufen.

So testen Sie Ihre API

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

2. Wählen Sie Ihre API aus.

3. Notieren Sie sich die Aufruf-URL Ihrer API.

   

4. Kopieren Sie die Aufruf-URL Ihrer API und geben Sie sie in einen Webbrowser ein. Hängen Sie den Namen Ihrer Lambda-Funktion an Ihre Aufruf-URL an, um Ihre Lambda-Funktion aufzurufen. Standardmäßig erstellt die API-Gateway-Konsole eine Route mit dem gleichen Namen wie Ihre Lambda-Funktion, my-function.

   Die URL sollte wie folgt aussehen: https://abcdef123.execute-api.us-east-2.amazonaws.com/my-function.

   Ihr Browser sendet eine GET-Anforderung an die API.

5. Verifizieren Sie die Antwort Ihrer API. Sie sollten den Text "Hello from Lambda!" in Ihrem Browser sehen.

(Optional) Schritt 4: Bereinigen

Um unnötige Kosten zu vermeiden, löschen Sie die Ressourcen, die Sie im Rahmen dieser Übung „Erste Schritte“ erstellt haben. In den folgenden Schritten werden Ihre HTTP-API, Ihre Lambda-Funktion und die zugehörigen Ressourcen gelöscht.

So löschen Sie eine HTTP-API

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

2. Wählen Sie auf der Seite APIs eine API aus. Wählen Sie Actions und anschließend Delete.

3. Wählen Sie Delete (Löschen).

So löschen Sie eine Lambda-Funktion

1. Melden Sie sich bei der Lambda-Konsole unter https://console.aws.amazon.com/lambda an.

2. Wählen Sie auf der Seite Functions (Funktionen) eine Funktion aus. Wählen Sie Actions und anschließend Delete.

3. Wählen Sie Delete (Löschen).

So löschen Sie die Protokollgruppe einer Lambda-Funktion

1. Öffnen Sie in der Amazon CloudWatch-Konsole die Seite Log groups (Protokollgruppen).

2. Wählen Sie auf der Seite Log groups (Protokollgruppen) die Protokollgruppe (/aws/lambda/my-function) der Funktion aus. Wählen Sie Actions (Aktionen) und dann Delete log group (Protokollgruppe löschen) aus.

3. Wählen Sie Delete (Löschen).

So löschen Sie die Ausführungsrolle einer Lambda-Funktion

1. Öffnen Sie in der AWS Identity and Access Management-Konsole die Seite Rollen.

2. Wählen Sie die Rolle der Funktion aus, zum Beispie, my-function-31exxmpl.

3. Wählen Sie Delete role (Rolle löschen) aus.

4. Wählen Sie Yes, delete (Ja, löschen) aus.

Sie können die Erstellung und Bereinigung von AWS-Ressourcen mithilfe von AWS CloudFormation oder AWS SAM automatisieren. Unter AWS CloudFormation-Beispielvorlagen finden Sie Beispiele für AWS CloudFormation-Vorlagen.

Nächste Schritte

In diesem Beispiel haben Sie die AWS Management Console verwendet, um eine einfache HTTP-API zu erstellen. Die HTTP-API ruft eine Lambda-Funktion auf und gibt eine Antwort an Clients zurück.

Im Folgenden sind die nächsten Schritte aufgeführt, wenn Sie weiterhin mit API Gateway arbeiten.

• Konfigurieren Sie zusätzliche Arten von API-Integrationen, einschließlich:

  • HTTP-Endpunkte

  • Private Ressourcen in einer VPC, wie Amazon ECS Services

  • AWS-Services wie Amazon Simple Queue Service, AWS Step Functions und Kinesis Data Streams

• Kontrollieren des Zugriffs auf Ihre APIs

• Aktivieren der Protokollierung für Ihre Instance

• Konfigurieren der Drosselung für Ihre APIs

• Konfigurieren benutzerdefinierter Domänen für Ihre APIs

Hilfe zu Amazon API Gateway aus der Community erhalten Sie im API Gateway-Diskussionsforum. Wenn Sie dieses Forum besuchen, verlangt AWS möglicherweise, dass Sie sich anmelden.

Hilfe zu API Gateway direkt von AWS erhalten Sie über die Support-Optionen auf der AWS-Support-Seite.

Weitere Informationen finden Sie außerdem in unseren häufig gestellten Fragen (FAQs). Außerdem können Sie uns direkt kontaktieren.