Amazon API Gateway-Konzepte

API Gateway ist ein AWS Dienst, der Folgendes unterstützt:

Eine Sammlung von HTTP-Ressourcen und -Methoden, die in Backend-HTTP-Endpunkte, Lambda-Funktionen oder andere Dienste integriert sind. AWS Sie können diese Sammlung in einer oder mehreren Stufen bereitstellen. In der Regel werden API-Ressourcen in einer Ressourcenstruktur organisiert, die der Anwendungslogik entspricht. Jede API-Ressource kann eine oder mehrere API-Methoden offenlegen, die eindeutige HTTP-Verben haben, die von API Gateway unterstützt werden. Weitere Informationen finden Sie unter Zwischen REST-APIs und HTTP-APIs wählen.

Eine Sammlung von Routen und Methoden, die mit Backend-HTTP-Endpunkten oder Lambda-Funktionen integriert sind. Sie können diese Sammlung in einer oder mehreren Stufen bereitstellen. Jede Route kann eine oder mehrere API-Methoden bereitstellen, die eindeutige HTTP-Verben haben, die von API Gateway unterstützt werden. Weitere Informationen finden Sie unter Zwischen REST-APIs und HTTP-APIs wählen.

Eine Sammlung von WebSocket Routen und Routenschlüsseln, die in Backend-HTTP-Endpunkte, Lambda-Funktionen oder andere Dienste integriert sind. AWS Sie können diese Sammlung in einer oder mehreren Stufen bereitstellen. API-Methoden werden über WebSocket Frontend-Verbindungen aufgerufen, die Sie einem registrierten benutzerdefinierten Domainnamen zuordnen können.

Eine Point-in-Time-Snapshot Ihrer API Gateway-API zu einem bestimmten Zeitpunkt. Damit eine Bereitstellung von einem Client verwendet werden kann, muss sie mindestens einer API-Stufe zugeordnet sein.

Ihr AWS Konto, dem eine API Gateway-Bereitstellung gehört (z. B. ein Dienstanbieter, der auch programmgesteuerten Zugriff unterstützt).

Ein Hostname für eine API in API Gateway, die in einer bestimmten Region bereitgestellt wird. Der Hostname hat das Format {api-id}.execute-api.{region}.amazonaws.com. Die folgenden Arten von API-Endpunkten werden unterstützt:

Eine alphanumerische Zeichenfolge, die API Gateway verwendet, um einen App-Entwickler zu identifizieren, der Ihren REST oder Ihre WebSocket API verwendet. API Gateway kann API-Schlüssel für Sie erstellen. Alternativ können Sie Schlüssel aus einer CSV-Datei importieren. Sie können API-Schlüssel zusammen mit Lambda-Genehmigern oder Nutzungsplänen verwenden, um den Zugriff auf Ihre APIs zu steuern.

Siehe API-Endpunkte.

Siehe API-Developer.

Ein logischer Verweis auf einen Lebenszyklusstatus Ihres API (z. B. "dev", "prod", "Beta", "v2"). API-Stufen werden mit API-ID und Stufenname bezeichnet.

Ein App-Ersteller, der möglicherweise über ein AWS Konto verfügt oder nicht und mit der API interagiert, die Sie, der API-Entwickler, bereitgestellt haben. App-Developer sind Ihre Kunden. Ein App-Developer wird in der Regel durch einen API-Schlüssel identifiziert.

Wenn ein neuer Client über eine WebSocket Verbindung verbunden ist, können Sie eine Integration in API Gateway aufrufen, um die Rückruf-URL des Kunden zu speichern. Sie können diese Rückruf-URL dann zum Senden von Nachrichten vom Backend-System zum Client verwenden.

Eine Anwendung, bei der API-Anbieter ihre APIs und API-Dokumentation an API-Verbraucher weitergeben können. APIs sind in Produkte gruppiert. Dabei handelt es sich um eine Sammlung von REST-API-Endpunkten, API-Dokumentation und ergänzender Produktdokumentation.

Siehe API Gateway-Portale.

Der Standard-Hostname einer API-Gateway-API, die in der angegebenen Region bereitgestellt wird, wobei eine CloudFront Verteilung verwendet wird, um den Kundenzugriff in der Regel aus verschiedenen AWS Regionen zu erleichtern. API-Anfragen werden an den nächstgelegenen CloudFront Point of Presence (POP) weitergeleitet, was in der Regel die Verbindungszeit für geografisch unterschiedliche Kunden verbessert.

Siehe API-Endpunkte.

Die interne Schnittstelle einer WebSocket API-Route oder REST-API-Methode in API Gateway, in der Sie den Hauptteil einer Routenanfrage oder die Parameter und den Hauptteil einer Methodenanforderung den vom Backend benötigten Formaten zuordnen.

Die interne Schnittstelle einer WebSocket API-Route oder REST-API-Methode in API Gateway, in der Sie die vom Backend empfangenen Statuscodes, Header und Nutzdaten dem Antwortformat zuordnen, das an eine Client-App zurückgegeben wird.

Ein Skript in Velocity Template Language (VTL), mit dem der Anforderungstext im Frontend-Datenformat in das Backend-Datenformat konvertiert wird oder mit dem der Antworttext aus dem Backend-Datenformat in das Frontend-Datenformat konvertiert wird. Zuweisungsvorlagen können in der Integrationsanforderung oder in der Integrationsantwort angegeben werden. Sie können auf Daten verweisen, die zur Laufzeit als Kontext- und Stufenvariablen zur Verfügung gestellt werden.

Die Zuordnung kann so einfach wie eine Identitätstransformation sein, mit der für eine Anforderung Header oder Text unverändert durch die Integration vom Client an das Backend übergeben werden. Das Gleiche gilt für eine Antwort, in der die Nutzlast vom Backend an den Client übergeben wird.

Die öffentliche Schnittstelle einer API-Methode in API Gateway, die die Parameter und den Text vorgibt, die ein App-Entwickler in Anfragen senden muss, um über die API auf das Backend zugreifen zu können.

Die öffentliche Schnittstelle einer REST-API, die Statuscodes, Header und Textmodelle vorgibt, die ein App-Developer in Antworten von der API erwarten sollte.

Bei einer Mock-Integration werden API-Antworten direkt von API Gateway generiert, ohne dass ein Integrations-Backend erforderlich ist. Als API-Entwickler entscheiden Sie, wie API Gateway auf eine Mock-Integrationsanfrage antwortet. Dazu konfigurieren Sie die Integrationsanforderung und -antwort der Methode, um einer Antwort einen bestimmten Statuscode zuzuweisen.

Ein Datenschema, das die Datenstruktur einer Anforderungs- oder Antwortnutzlast angibt. Ein Modell ist erforderlich, um ein stark typisiertes SDK einer API zu generieren. Es wird auch zur Validierung der Nutzlast verwendet. Ein Modell bietet praktische Vorteile, da eine Beispiel-Zuweisungsvorlage generiert wird, über die eine Produktionszuweisungsvorlage initiiert werden kann. Für die Erstellung einer Zuweisungsvorlage ist ein Modell zwar hilfreich, aber nicht erforderlich.

Siehe Entwicklerportal.

Ein Dienst oder eine Funktion, die Sie teilen möchten. Ihr Portalprodukt ist eine Sammlung von Produkt-REST-Endpunkten und Produktseiten. Produkt-REST-Endpunkte sind die Zugangspunkte zu Ihrem Portalprodukt. Sie bestehen aus dem Pfad und der Methode einer REST-API sowie der Phase, in der sie bereitgestellt wird. Produktseiten sind Dokumentationen, die Sie bereitstellen, um zu erklären, wie API-Verbraucher Ihre Produktendpunkte verwenden können. Sie können Produkte kontoübergreifend teilen AWS , um sie zu Portalen hinzuzufügen.

Siehe Ein Produkt erstellen.

Siehe Privater API-Endpunkt.

Ein API-Endpunkt, der über Schnittstellen-VPC-Endpunkte bereitgestellt wird und einem Client den sicheren Zugriff auf private API-Ressourcen innerhalb einer VPC ermöglicht. Private APIs sind vom öffentlichen Internet isoliert und können nur über VPC-Endpunkte erreicht werden, für die API Gateway Zugriff gewährt wurde.

Ein API Gateway-Integrationstyp für einen Client zum Zugriff auf Ressourcen in der VPC eines Kunden über einen privaten REST-API-Endpunkt, ohne die Ressourcen im öffentlichen Internet offenzulegen.

Eine vereinfachte API Gateway-Integrationskonfiguration. Sie können eine Proxy-Integration als HTTP-Proxy-Integration oder als Lambda-Proxy-Integration einrichten.

Bei einer HTTP-Proxy-Integration leitet API Gateway die gesamte Anfrage und Antwort zwischen dem Frontend und einem HTTP-Backend weiter. Bei der Lambda-Proxy-Integration sendet API Gateway die gesamte Anfrage als Eingabe an eine Lambda-Funktion im Backend. API Gateway wandelt dann die Ausgabe der Lambda-Funktion in eine HTTP-Antwort des Frontends um.

In REST-APIs wird die Proxy-Integration meist mit einer Proxy-Ressource verwendet, die durch eine gierige Pfadvariable (z. B. {proxy+}) und die Catch-all-Methode ANY dargestellt wird.

Sie können die Schnellerstellung verwenden, um die Erstellung einer HTTP-API zu vereinfachen. Quick Create erstellt eine API mit einer Lambda- oder HTTP-Integration, eine Catch-All-Standardroute und eine Standardphase, die für die automatische Bereitstellung von Änderungen konfiguriert ist. Weitere Informationen finden Sie unter Erstellen Sie eine HTTP-API mithilfe der AWS CLI.

Der Hostname einer API, die in der angegebenen Region bereitgestellt wird und für die Bedienung von Clients wie EC2-Instances in derselben AWS Region vorgesehen ist. API-Anfragen werden direkt an die Region-specific API Gateway-API weitergeleitet, ohne dass eine CloudFront Verteilung erfolgt. Bei regionsinternen Anfragen umgeht ein regionaler Endpunkt den unnötigen Hin- und Rückweg zu einer CloudFront Distribution.

Darüber hinaus können Sie latenzbasiertes Routing an den regionalen Endpunkten anwenden, um eine API für mehrere Regionen mithilfe derselben regionalen API-Endpunkt-Konfiguration bereitzustellen, dieselben benutzerdefinierten Domänennamen für jede bereitgestellte API festzulegen und latenzbasierte DNS-Datensätze in Route 53 zu konfigurieren, um Client-Anfragen an die Region mit der niedrigsten Latenz zu leiten.

Siehe API-Endpunkte.

Eine WebSocket Route in API Gateway wird verwendet, um eingehende Nachrichten auf der Grundlage des Nachrichteninhalts an eine bestimmte Integration weiterzuleiten, z. B. an eine AWS Lambda Funktion. Wenn Sie Ihre WebSocket API definieren, geben Sie einen Routenschlüssel und ein Integrations-Backend an. Der Routenschlüssel ist ein Attribut im Nachrichtentext. Wenn der Routenschlüssel in einer eingehenden Nachricht abgeglichen wird, wird das Integrations-Backend aufgerufen.

Es kann auch eine Standardroute für nicht übereinstimmende Routenschlüssel oder zur Angabe eines Proxy-Modells festgelegt werden, mit dem die Nachricht unverändert an Backend-Komponenten übergeben wird, die die Weiterleitung und Verarbeitung der Anforderung durchführen.

Die öffentliche Schnittstelle einer WebSocket API-Methode in API Gateway, die den Text definiert, den ein App-Entwickler in den Anfragen senden muss, um über die API auf das Backend zuzugreifen.

Die öffentliche Schnittstelle einer WebSocket API, die die Statuscodes, Header und Textmodelle definiert, die ein App-Entwickler von API Gateway erwarten sollte.

Ein Nutzungsplan bietet ausgewählten API-Clients Zugriff auf einen oder mehrere bereitgestellte REST- oder WebSocket APIs. Sie können einen Nutzungsplan dazu verwenden, die Drosselungs- und Kontingentlimits zu konfigurieren, die für einzelne Client-API-Schlüssel erzwungen werden.

API Gateway unterhält eine beständige Verbindung zwischen Clients und API Gateway. Es gibt keine beständige Verbindung zwischen API Gateway und Backend-Integrationen wie z. B. Lambda-Funktionen. Backend-Services werden nach Bedarf aufgerufen, basierend auf dem Inhalt der Nachrichten, die von Clients empfangen werden.