Entwickeln einer HTTP-API in API Gateway - 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.

Entwickeln einer HTTP-API in API Gateway

Dieser Abschnitt enthält Details zu den API Gateway-Funktionen, die Sie bei der Entwicklung Ihrer API Gateway-APIs benötigen.

Während Sie Ihre API Gateway-API entwickeln, entscheiden Sie sich für eine Reihe von Merkmalen Ihrer API. Diese Eigenschaften hängen davon ab, wofür Ihre API verwendet werden soll. So könnte es beispielsweise sein, dass Sie es nur bestimmten Clients gestatten möchten, die API aufzurufen. Vielleicht soll die API aber auch für alle verfügbar sein. Vielleicht benötigen Sie einen API-Aufruf, um eine Lambda-Funktion auszuführen, eine Datenbankabfrage durchzuführen oder eine Anwendung aufzurufen.

Erstellen einer HTTP-API

Um eine funktionale API erstellen zu können, benötigen Sie mindestens eine Route, eine Integration, eine Phase und eine Bereitstellung.

Die folgenden Beispiele zeigen, wie Sie eine API mit einer AWS Lambda oder HTTP-Integration, einer Route und einer Standardstufe erstellen, die so konfiguriert ist, dass Änderungen automatisch bereitgestellt werden.

In diesem Leitfaden wird davon ausgegangen, dass Sie bereits mit API Gateway und Lambda vertraut sind. Einen ausführlicheren Leitfaden finden Sie unter Erste Schritte mit API Gateway.

Erstellen Sie eine HTTP-API mithilfe der AWS Management Console

  1. Öffnen Sie die API Gateway-Konsole.

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

  3. Wählen Sie unter HTTP-API die Option Entwickeln aus.

  4. Wählen Sie Add integration (Integration hinzufügen) und wählen Sie dann eine AWS Lambda -Funktion oder geben Sie einen HTTP-Endpunkt ein.

  5. Geben Sie im Feld Name einen Namen für Ihre API ein.

  6. Wählen Sie Review and create.

  7. Wählen Sie Create aus.

Jetzt kann Ihre API aufgerufen werden. Sie können Ihre API testen, indem Sie die Aufruf-URL in einem Browser eingeben oder cURL verwenden.

curl https://api-id.execute-api.us-east-2.amazonaws.com

Erstellen Sie eine HTTP-API mithilfe der AWS CLI

Sie können Quick Create verwenden, um eine API mit einer Lambda- oder HTTP-Integration, eine Catch-All-Standardroute und eine Standardphase zu erstellen, die für die automatische Bereitstellung von Änderungen konfiguriert ist. Der folgende Befehl verwendet Quick Create, um eine API zu erstellen, die in eine Lambda-Funktion im Backend integriert werden kann.

Anmerkung

Um eine Lambda-Integration aufzurufen, muss API Gateway über die erforderlichen Berechtigungen verfügen. Sie können eine ressourcenbasierte Richtlinie oder eine IAM-Rolle verwenden, um API-Gateway Berechtigungen zum Aufrufen einer Lambda-Funktion zu erteilen. Weitere Informationen finden Sie unter AWS Lambda Berechtigungen im AWS Lambda Entwicklerhandbuch.

aws apigatewayv2 create-api --name my-api --protocol-type HTTP --target arn:aws:lambda:us-east-2:123456789012:function:function-name

Jetzt kann Ihre API aufgerufen werden. Sie können Ihre API testen, indem Sie die Aufruf-URL in einem Browser eingeben oder cURL verwenden.

curl https://api-id.execute-api.us-east-2.amazonaws.com