Amazon API Gateway-Konzepte

APIGateway ist ein AWS Dienst, der Folgendes unterstützt:

Eine Sammlung von HTTP Ressourcen und Methoden, die in HTTP Backend-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 entsprechend der Anwendungslogik in einem Ressourcenbaum organisiert. Jede API Ressource kann eine oder mehrere API Methoden verfügbar machen, deren eindeutige HTTP Verben von API Gateway unterstützt werden. Weitere Informationen finden Sie unter Wähle zwischen REST APIs und HTTP APIs.

Eine Sammlung von Routen und Methoden, die in HTTP Backend-Endpunkte oder Lambda-Funktionen integriert sind. Sie können diese Sammlung in einer oder mehreren Stufen bereitstellen. Jede Route kann eine oder mehrere API Methoden verfügbar machen, deren eindeutige HTTP Verben von Gateway unterstützt werden. API Weitere Informationen finden Sie unter Wähle zwischen REST APIs und HTTP APIs.

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

Ein point-in-time Schnappschuss Ihres API Gateways. API Damit die Bereitstellung von Clients verwendet werden kann, muss sie einer oder mehreren API Phasen zugeordnet sein.

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

Ein Hostname für ein API In-Gateway, das API 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 Ihr REST oder WebSocket API verwendet. APIGateway kann API Schlüssel in Ihrem Namen generieren, oder Sie können sie aus einer CSV Datei importieren. Sie können API Schlüssel zusammen mit Lambda-Autorisierern oder Nutzungsplänen verwenden, um den Zugriff auf Ihre zu kontrollieren. APIs

Siehe Endpunkte. API

Siehe APIEntwickler.

Ein logischer Verweis auf Ihren Lebenszyklusstatus API (z. B. 'dev', 'prod', 'beta', 'v2'). APIPhasen werden anhand der API ID und des Phasennamens identifiziert.

Ein App-Ersteller, der möglicherweise ein AWS Konto hat oder auch nicht und mit dem interagiert, API das Sie als API Entwickler bereitgestellt haben. App-Developer sind Ihre Kunden. Ein App-Entwickler wird in der Regel anhand eines APISchlüssels identifiziert.

Wenn mit einem neuen Client über eine WebSocket Verbindung verbunden wird, können Sie eine Integration in API Gateway aufrufen, um den Rückruf URL des Clients zu speichern. Sie können diesen Rückruf dann verwenden, URL um Nachrichten vom Backend-System an den Client zu senden.

Eine Anwendung, mit der Ihre Kunden Ihre API Produkte registrieren, entdecken und abonnieren können (APIGateway-Nutzungspläne), ihre API Schlüssel verwalten und ihre Nutzungskennzahlen für Sie einsehen können. APIs

Der Standard-Hostname eines API GatewaysAPI, das in der angegebenen Region bereitgestellt wird und dabei eine CloudFront Verteilung verwendet, um den Client-Zugriff in der Regel aus verschiedenen Regionen zu erleichtern. AWS APIAnfragen werden an den nächstgelegenen CloudFront Point of Presence (POP) weitergeleitet, was in der Regel die Verbindungszeit für geografisch unterschiedliche Clients verbessert.

Siehe EndpunkteAPI.

Die interne Schnittstelle einer WebSocket API Route oder REST API Methode in API Gateway, in der Sie den Hauptteil einer Routenanforderung 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), das einen Anforderungstext vom Frontend-Datenformat in das Backend-Datenformat oder einen Antworttext vom Backend-Datenformat in das Frontend-Datenformat umwandelt. 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 Hauptteil definiert, die ein App-Entwickler in Anfragen senden muss, um über das auf das Backend zuzugreifen. API

Die öffentliche Schnittstelle von a RESTAPI, die die Statuscodes, Header und Textmodelle definiert, die ein App-Entwickler in Antworten von erwarten sollte. API

Bei einer Scheinintegration 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 simulierte Integrationsanfrage reagiert. 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 für die Generierung eines stark typisierten SDK API von erforderlich. 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 Privater API Endpunkt.

Ein API Endpunkt, der über VPC Schnittstellenendpunkte verfügbar gemacht wird und einem Client den sicheren Zugriff auf private API Ressourcen innerhalb eines VPC ermöglicht. Private APIs Geräte sind vom öffentlichen Internet isoliert, und auf sie kann nur über VPC Endpunkte für API Gateway zugegriffen werden, denen der Zugriff gewährt wurde.

Ein API Gateway-Integrationstyp, mit dem ein Client VPC über einen privaten REST API Endpunkt auf Ressourcen innerhalb eines Kunden zugreifen kann, ohne die Ressourcen dem öffentlichen Internet zugänglich zu machen.

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

Bei der HTTP Proxyintegration leitet API Gateway die gesamte Anfrage und Antwort zwischen dem Frontend und einem HTTP Backend weiter. Für die Lambda-Proxyintegration sendet API Gateway die gesamte Anfrage als Eingabe an eine Back-End-Lambda-Funktion. APIGateway wandelt dann die Ausgabe der Lambda-Funktion in eine HTTP Frontend-Antwort um.

In REST APIs wird die Proxyintegration am häufigsten mit einer Proxy-Ressource verwendet, die durch eine Greedy Path-Variable (z. B.{proxy+}) in Kombination mit einer ANY Catch-All-Methode dargestellt wird.

Sie können Quick Create verwenden, um die Erstellung eines zu vereinfachen. HTTP API Quick Create erstellt eine API mit Lambda oder HTTP Integration, eine Standard-Catch-All-Route und eine Standardphase, die so konfiguriert ist, dass Änderungen automatisch bereitgestellt werden. Weitere Informationen finden Sie unter Erstellen Sie eine HTTP-API mithilfe der AWS CLI.

Der Hostname einesAPI, der in der angegebenen Region bereitgestellt wird und für Clients, z. B. EC2 Instances, in derselben AWS Region vorgesehen ist. APIAnfragen werden direkt an das regionsspezifische API Gateway gerichtet, API ohne dass eine Verteilung erforderlich ist. CloudFront Bei Anfragen innerhalb einer Region umgeht ein regionaler Endpunkt den unnötigen Roundtrip zu einer Distribution. CloudFront

Darüber hinaus können Sie latenzbasiertes Routing auf regionalen Endpunkten anwenden, API um einen in mehreren Regionen mit derselben regionalen API Endpunktkonfiguration bereitzustellen, für jede Bereitstellung denselben benutzerdefinierten Domänennamen festzulegen und latenzbasierte DNS Datensätze in Route 53 so zu konfigurierenAPI, dass Clientanfragen an die Region mit der niedrigsten Latenz weitergeleitet werden.

Siehe Endpunkte. API

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 definieren WebSocket API, 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 Hauptteil definiert, den ein App-Entwickler in den Anfragen für den Zugriff auf das Backend über senden muss. API

Die öffentliche Schnittstelle von a WebSocket API, die die Statuscodes, Header und Body-Modelle 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 verwenden, um Drosselung und Kontingentbeschränkungen zu konfigurieren, die für einzelne Client-Schlüssel gelten. API

APIGateway unterhält eine persistente Verbindung zwischen Clients und API Gateway selbst. Es besteht keine dauerhafte Verbindung zwischen API Gateway und Backend-Integrationen wie Lambda-Funktionen. Backend-Services werden nach Bedarf aufgerufen, basierend auf dem Inhalt der Nachrichten, die von Clients empfangen werden.