APIAnwendungsfälle für Gateways

Der folgende Abschnitt mit Anwendungsfällen bietet einen Überblick über die verschiedenen API Gateway-Typen APIs und die verschiedenen Arten von Entwicklern, die API Gateway verwenden. Ausführlichere Informationen zum Unterschied zwischen REST APIs und HTTP APIs finden Sie unterWähle zwischen REST APIs und HTTP APIs.

Verwenden Sie API Gateway, um Folgendes zu erstellen REST APIs

Ein API Gateway REST API besteht aus Ressourcen und Methoden. Eine Ressource ist eine logische Entität, auf die eine App über einen Ressourcenpfad zugreifen kann. Eine Methode entspricht einer REST API Anfrage, die von Ihrem Benutzer eingereicht API und der Antwort an den Benutzer zurückgegeben wird.

So könnte beispielsweise /incomes der Pfad der Ressource sein, die das Einkommen des App-Benutzers angibt. Eine Ressource kann eine oder mehrere Operationen haben, die durch entsprechende HTTP Verben wieGET,, POST PUTPATCH, und DELETE definiert sind. Eine Kombination aus einem Ressourcenpfad und einer Operation identifiziert eine Methode von. API Die Methode POST /incomes beispielsweise könnte das Einkommen des Aufrufers hinzufügen, und die Methode GET /expenses könnte die vom Aufrufer angegebenen Ausgaben abfragen.

Die App benötigt keine Informationen dazu, wo auf dem Backend die angeforderten Daten gespeichert und abgerufen werden. In API Gateway ist REST APIs das Frontend durch Methodenanfragen und Methodenantworten gekapselt. Die API Schnittstellen zum Backend erfolgen über Integrationsanfragen und Integrationsantworten.

Bei DynamoDB als Backend richtet der API Entwickler die Integrationsanforderung beispielsweise so ein, dass die eingehende Methodenanfrage an das gewählte Backend weitergeleitet wird. Das Setup umfasst Spezifikationen einer geeigneten DynamoDB-Aktion, der erforderlichen IAM Rollen und Richtlinien sowie der erforderlichen Eingabedatentransformation. Das Backend gibt das Ergebnis als Integrationsantwort an API Gateway zurück.

Um die Integrationsantwort auf eine geeignete Methodenantwort (mit einem bestimmten HTTP Statuscode) an den Client weiterzuleiten, können Sie die Integrationsantwort so konfigurieren, dass die erforderlichen Antwortparameter von der Integration zur Methode zugeordnet werden. Falls erforderlich, übertragen Sie anschließend das Backend-Ausgabedatenformat in das für das Frontend erforderliche Format. APIGateway ermöglicht es Ihnen, ein Schema oder Modell für die Payload zu definieren, um die Einrichtung der Body-Mapping-Vorlage zu vereinfachen.

APIGateway bietet REST API Verwaltungsfunktionen wie die folgenden:

• Support für die Generierung SDKs und Erstellung von API Dokumentation mithilfe von API Gateway-Erweiterungen für Open API

• Drosselung von Anfragen HTTP

Verwenden Sie API Gateway, um zu erstellen HTTP APIs

HTTPAPIsermöglichen es Ihnen, RESTful APIs mit geringerer Latenz und geringeren Kosten zu erstellen als RESTAPIs.

Sie können HTTP APIs es verwenden, um Anfragen an AWS Lambda Funktionen oder an jeden öffentlich routbaren HTTP Endpunkt zu senden.

Sie können beispielsweise eine erstellen, HTTP API die in eine Lambda-Funktion im Backend integriert ist. Wenn ein Client Ihren aufruftAPI, sendet API Gateway die Anfrage an die Lambda-Funktion und gibt die Antwort der Funktion an den Client zurück.

HTTPAPIsunterstützt OpenID Connect und OAuth2.0-Autorisierung. Sie bieten integrierte Unterstützung für die gemeinsame Nutzung von Ressourcen zwischen verschiedenen Quellen (CORS) und automatische Bereitstellungen.

Weitere Informationen hierzu finden Sie unter Wähle zwischen REST APIs und HTTP APIs.

Verwenden Sie API Gateway zum Erstellen WebSocket APIs

In einem WebSocket API können sowohl der Client als auch der Server jederzeit Nachrichten aneinander senden. Backend-Server können problemlos Daten an verbundene Benutzer und Geräte übertragen, ohne komplexe Abfragemechanismen implementieren zu müssen.

Sie könnten beispielsweise mithilfe eines API Gateways eine serverlose Anwendung erstellen WebSocket API und AWS Lambda Nachrichten an einzelne Benutzer oder Benutzergruppen in einem Chatroom senden und empfangen. Oder Sie könnten Back-End-Dienste wie AWS Lambda Amazon Kinesis oder einen HTTP Endpunkt aufrufen, der auf Nachrichteninhalten basiert.

Sie können API Gateway verwenden, WebSocket APIs um sichere Kommunikationsanwendungen in Echtzeit zu erstellen, ohne Server bereitstellen oder verwalten zu müssen, um Verbindungen oder umfangreichen Datenaustausch zu verwalten. Zu vorgesehenen Anwendungsfällen gehören Echtzeit-Anwendungen wie die folgenden:

• Chat-Anwendungen

• Echtzeit-Dashboards, wie z. B. Aktienticker

• Echtzeit-Warnungen und -Benachrichtigungen

APIGateway bietet WebSocket API Verwaltungsfunktionen wie die folgenden:

• Überwachung und Drosselung von Verbindungen und Nachrichten

• Wird verwendet AWS X-Ray , um Nachrichten auf ihrem Weg durch die APIs Back-End-Dienste zu verfolgen

• Einfache Integration mit HTTP HTTPS /-Endpunkten

Wer verwendet API Gateway?

Es gibt zwei Arten von Entwicklern, die API Gateway verwenden: API Entwickler und App-Entwickler.

Ein API Entwickler erstellt und implementiert eineAPI, um die erforderlichen Funktionen in API Gateway zu aktivieren. Der API Entwickler muss ein Benutzer des AWS Kontos sein, dem das API gehört.

Ein App-Entwickler erstellt eine funktionierende Anwendung zum Aufrufen von AWS Diensten, indem er eine WebSocket oder von einem API Entwickler REST API erstellte Anwendung in API Gateway aufruft.

Der App-Entwickler ist der Kunde des API Entwicklers. Der App-Entwickler benötigt kein AWS Konto, vorausgesetzt, dass er API entweder keine IAM Berechtigungen benötigt oder die Autorisierung von Benutzern über externe Federated Identity Provider unterstützt, die von Amazon Cognito User Pool Identity Federation unterstützt werden. Zu diesen Identitätsanbietern gehören Amazon, Amazon Cognito-Benutzerpools, Facebook und Google.

Ein Gateway erstellen und verwalten API API

Ein API Entwickler verwendet die sogenannte API Gateway-Dienstkomponente für die API Verwaltungapigateway, um eine zu erstellen, zu konfigurieren und bereitzustellenAPI.

Als API Entwickler können Sie eine erstellen und verwalten, API indem Sie die API Gateway-Konsole verwenden, die unter beschrieben istErste Schritte mit API Gateway, oder indem Sie die aufrufenAPI-Referenzen. Es gibt mehrere Möglichkeiten, dies aufzurufenAPI. Dazu gehören die Verwendung von AWS Command Line Interface (AWS CLI) oder die Verwendung eines AWS SDK. Darüber hinaus können Sie die API Erstellung mit AWS CloudFormation Vorlagen oder (im Fall von REST APIs und HTTPAPIs) aktivierenAPIErweiterungen für API Gateway öffnen.

Eine Liste der Regionen, in denen API Gateway verfügbar ist, sowie der zugehörigen Kontrollservice-Endpunkte finden Sie unter Amazon API Gateway Endpoints and Quotas.

Ein Gateway aufrufen API API

Ein App-Entwickler verwendet die API Gateway-Dienstkomponente für die API Ausführung, benanntexecute-api, um eine aufzurufenAPI, die in API Gateway erstellt oder bereitgestellt wurde. Die zugrunde liegenden Programmierentitäten werden von den erstellten API Entitäten verfügbar gemacht. Es gibt verschiedene Möglichkeiten, einen solchen aufzurufenAPI. Weitere Informationen hierzu finden Sie unter Rufen Sie REST-APIs im API Gateway auf und APIs aufrufen WebSocket .