Amazon API Gateway – Häufig gestellte Fragen

Amazon API Gateway ist ein vollständig verwalteter Service, der das Veröffentlichen, Warten, Überwachen und Sichern von APIs für Entwickler in jeder beliebigen Größenordnung vereinfacht. Mit wenigen Klicks in der AWS-Managementkonsole können Sie eine API erstellen, die als "Haupteingang" für Anwendungen dient, um auf Daten, Geschäftslogik oder Funktionen von Ihren Backend-Services zuzugreifen, etwa Anwendungen, die auf Amazon Elastic Compute Cloud (Amazon EC2), Amazon Elastic Container Service (Amazon ECS) oder AWS Elastic Beanstalk laufen, Code, der auf AWS Lambda läuft, oder eine beliebige Webanwendung. Amazon API Gateway handhabt sämtliche Aufgaben im Zusammenhang mit der Annahme und Verarbeitung von Hunderttausenden gleichzeitiger API-Aufrufe, etwa Datenverkehrmanagement, Autorisierung und Zugriffssteuerung, Überwachung und API-Versionsmanagement. Bei Amazon API Gateway fallen weder Mindestgebühren noch Vorabkosten an. Bei HTTP APIs und REST APIs bezahlen Sie lediglich für eingehende API-Aufrufe und ausgehende Datenübertragungen. Für WebSocket-APIs bezahlen Sie lediglich für Nachrichten, die gesendet und empfangen werden, und für die Zeit, die ein Benutzer/Gerät mit dem Websocket-API verbunden ist.

Amazon API Gateway bietet Entwicklern einen einfachen, flexiblen, vollständig verwalteten, nutzungsabhängigen Service, der alle Aspekte beim Erstellen und Betreiben robuster APIs für Anwendungs-Backends handhabt. Mit API Gateway können Sie neue Services schneller starten, und zwar mit reduzierten Investitionen, sodass Sie sich darauf konzentrieren können, Ihre Haupt-Unternehmensdienste aufzubauen. Amazon API Gateway wurde entwickelt, um Ihnen bei mehreren Aspekten des Erstellens und Verwaltens von APIs zu helfen:

1) Messung. API Gateway hilft Ihnen, Pläne zu definieren, die den Zugriff externer Entwickler auf Ihre APIs messen und einschränken. Sie können eine Zusammenstellung von Plänen definieren, eine Einschränkung der maximalen Bandbreite konfigurieren und Quotenlimits pro API-Schlüssel festlegen. API Gateway misst automatisch den Datenverkehr zu Ihren APIs und ermöglicht Ihnen, Nutzungsdaten für die einzelnen API-Schlüssel zu extrahieren.

2) Sicherheit. API Gateway bietet Ihnen mehrere Tools zum Autorisieren des Zugriffs auf Ihre APIs und zur Steuerung des Zugriffs auf die Serviceoperation. Mit Amazon API Gateway können Sie die AWS-Verwaltungs- und Sicherheits-Tools verwenden, etwa AWS Identity and Access Management (IAM) und Amazon Cognito, um den Zugriff auf Ihre APIs zu autorisieren. API Gateway kann signierte API-Aufrufe in Ihrem Namen mithilfe derselben Methode prüfen, die AWS für seine eigenen APIs verwendet. Mithilfe von benutzerdefinierten Genehmigern, die als AWS Lambda-Funktionen geschrieben wurden, können Sie API Gateway zum Prüfen eingehender Bearer-Token verwenden. Autorisierungsbedenken hinsichtlich Ihres Back-End-Codes erübrigen sich damit.

3) Ausfallsicherheit. API Gateway hilft Ihnen beim Verwalten des Datenverkehrs durch Einschränkung der maximalen Bandbreite, damit Backend-Operationen Datenverkehrsspitzen verarbeiten können. Außerdem hilft Ihnen API Gateway, die Leistung Ihrer APIs und die Latenz, die Ihre Endbenutzer wahrnehmen, durch das Zwischenspeichern der Ausgabe der API-Aufrufe zu verbessern. So wird vermieden, dass Ihre Backend-Systeme jedes Mal aufgerufen werden.

4) Überwachen von Vorgängen. Wenn eine veröffentlichte API genutzt wird, präsentiert API Gateway Ihnen ein Dashboard mit Metriken, damit Sie die Aufrufe Ihrer Dienste überwachen können. Das API-Gateway-Dashboard liefert Ihnen durch die Integration mit Amazon CloudWatch Back-End-Leistungsmetriken, die API-Aufrufe, Latenzdaten und Fehlerquoten umfassen. Sie können für jede einzelne Methode innerhalb Ihrer APIs detaillierte Metriken aktivieren und auch Fehler-, Zugriffs- oder Debug-Protokolle in CloudWatch Logs erhalten.

5) Verwaltung des Lebenszyklus. Nachdem eine API veröffentlicht wurde, müssen Sie häufig neue Versionen erstellen und testen, die Funktionen erweitern oder neue hinzufügen. Mit Amazon API Gateway können Sie mehrere API-Versionen und Stufen für jede einzelne Version gleichzeitig ausführen, sodass vorhandene Anwendungen weiterhin frühere API-Versionen aufrufen können, auch nachdem neue Versionen veröffentlicht wurden.

6) Konzipiert für Entwickler. Mit API Gateway können Sie schnell APIs erstellen und statische Inhalte für ihre Inhalte zuordnen, um den teamübergreifenden Entwicklungsaufwand und die Markteinführungszeit Ihrer Anwendungen zu reduzieren. Teams, die von Ihren APIs abhängig sind, können die Entwicklung beginnen, während Sie Ihre Backend-Prozesse aufbauen.

7) Bidirektionale Kommunikation in Echtzeit. Entwickeln Sie Anwendungen für den bidirektionalen Dialog in Echtzeit so wie Chatapps, Streaming-Dashboards und Benachrichtigungen, ohne Server ausführen oder verwalten zu müssen. API Gateway hält eine dauerhafte Verbindung zwischen den verbundenen Benutzern aufrecht und ermöglicht Nachrichtenaustausch zwischen ihnen.

Amazon API Gateway bietet zwei Optionen zur Erstellung von RESTful APIs – HTTP APIs und REST APIs – sowie eine Option zur Erstellung von WebSocket APIs.

HTTP-API: HTTP-APIs sind für die Entwicklung von APIs optimiert, die eine Proxy-Verbindung zu AWS Lambda-Funktionen oder HTTP-Backends herstellen. Damit sind sie ideal für Serverless-Workloads. Sie bieten aktuell keine API-Managementfunktionen.

REST-API: REST-APIs bieten API-Proxyfunktionalität und API-Verwaltungsfeatures in einer einzigen Lösung. REST APIs bieten API-Verwaltungsfunktionen wie Nutzungspläne, API-Schlüssel, Veröffentlichung und Monetarisierung von APIs.

WebSocket-API: WebSocket-APIs halten eine beständige Verbindung zwischen verbundenen Clients aufrecht, um eine Nachrichtenkommunikation in Echtzeit zu ermöglichen. Mit WebSocket-APIs in API Gateway können Sie Backend-Integrationen mit AWS Lambda-Funktionen, Amazon Kinesis oder einem beliebigen HTTP-Endpunkt definieren, die aufgerufen werden, wenn Nachrichten von den verbundenen Clients empfangen werden.

Um mit der Nutzung von HTTP APIs zu beginnen, können Sie die Amazon API Gateway-Konsole, das AWS CLI, die AWS SDKs oder AWS CloudFormation verwenden. Informationen zu den ersten Schritten mit HTTP APIs finden Sie in unserer Dokumentation.

Um mit der Nutzung von REST APIs zu beginnen, können Sie die Amazon API Gateway-Konsole, das AWS CLI oder die AWS SDKs verwenden. Informationen zu den ersten Schritten mit REST APIs finden Sie in unserer Dokumentation.

Sie können RESTful APIs sowohl mit HTTP APIs als auch REST APIs in Amazon API Gateway erstellen.

HTTP APIs sind für die Erstellung von APIs optimiert, die eine Proxy-Verbindung zu AWS Lambda-Funktionen oder HTTP-Backends herstellen. Damit sind sie ideal für serverlose Workloads. HTTP APIs sind eine günstigere und schnellere Alternative zu REST APIs, unterstützen aber aktuell keine API-Managementfunktionen. REST-APIs sind für Workloads gedacht, die API-Proxy-Funktionalität und API-Verwaltungsfunktionen in einer einzigen Lösung erfordern.

HTTP APIs sind ideal für:

1. die Erstellung von Proxy-APIs für AWS Lambda oder HTTP-Endpunkte
2. die Erstellung moderner APIs, die mit OIDC und OAuth 2-Autorisierung ausgestattet sind 
3. Workloads, die voraussichtlich sehr groß werden
4. APIs für latenzempfindliche Workloads

1. Kunden, die einen einzigen Preis für eine Universallösung bezahlen möchten, um ihre APIs zu erstellen, zu verwalten und zu veröffentlichen. 

HTTP APIs umfassen standardmäßig CORS-Unterstützung, OIDC und OAuth2-Unterstützung zur Authentifizierung und Autorisierung, sowie automatische Bereitstellung in Phasen.

Ja, Sie können mit OpenAPI 3 eine API-Definition importieren. Dies führt zur Erstellung von Routen, Integrationen und API-Modellen. Weitere Informationen zum Import von OpenAPI-Definitionen finden Sie in unserer Dokumentation.

Um von Ihrer aktuellen REST API zu einer HTTP API in Amazon API Gateway zu migrieren, gehen Sie wie folgt vor:

1. Überprüfen Sie, dass alle benötigten Funktionen in der HTTP-Variante verfügbar sind. Die vollständige Funktionsliste finden Sie in unserer Dokumentation. 
2. Navigieren Sie zu Ihrer REST API und exportieren Sie die OpenAPI-Definition aus Ihrer REST API
3. Navigieren Sie zu Ihrer HTTP API und importieren Sie die OpenAPI-Definition aus dem vorherigen Schritt
4. Testen Sie die API-Funktionen
5. Aktualisieren Sie Ihre Clients mit der neuen URL

Möglicherweise funktioniert Ihre API, aber Ihnen fallen einige fehlende Funktionen auf. Um fehlende Features zu ermitteln, sehen Sie sich die Felder Info, Warnung und Fehler des Importvorgangs an. Weitere Informationen zur Migration von REST APIs zu HTTP APIs finden Sie in unserer Dokumentation.

Navigieren Sie zunächst zu Ihrer REST API und exportieren Sie die OpenAPI-Definition aus Ihrer REST API. Navigieren Sie dann zu Ihrer HTTP API und importieren Sie die OpenAPI-Definition aus dem vorherigen Schritt Möglicherweise funktioniert Ihre API, aber Ihnen fallen einige fehlende Funktionen auf. Um fehlende Features zu ermitteln, sehen Sie sich die Felder Info, Warnung und Fehler des Importvorgangs an. Das AWS CLI gibt Informationen zu Ihrer API in den Info- und Warnfeldern zurück. Weitere Informationen finden Sie in unserer Dokumentation.

Um zu beginnen, können Sie zunächst eine WebSocket-API mit der AWS-Managementkonsole, der AWS CLI oder den AWS SDKs erstellen. Sie können dann das WebSocket-Routing so einstellen, dass die Backend-Services wie AWS Lambda, Amazon Kinesis oder Ihr HTTP-Endpunkt basierend auf dem Nachrichteninhalt aufgerufen werden. Informationen zu den ersten Schritten mit WebSocket-APIs im API-Gateway finden Sie in der Dokumentation.

Ja. Mit Amazon API Gateway erstellte APIs exponieren ausschließlich HTTPS-Endpunkte. Amazon API Gateway unterstützt keine unverschlüsselten Endpunkte (HTTP). Standardmäßig weist Amazon API Gateway der API eine interne Domain zu, die automatisch das Zertifikat von Amazon API Gateway verwendet. Wenn Sie die APIs, die ausgeführt werden sollen, unter einem benutzerdefinierten Domain-Namen konfigurieren, können Sie Ihr eigenes Zertifikat für die Domäne angeben.

Mit Amazon API Gateway aufgebaute APIs können beliebige Nutzlasten akzeptieren, die über HTTPS für HTTP APIs, REST-APIs und WebSocket APIs gesendet werden. Typische Datenformate sind JSON, XML, Parameter für Abfragezeichenfolgen und Anforderungsheader. Sie können für Ihre API-Antworten beliebige Arten von Inhalten deklarieren und dann die Transformationsvorlagen verwenden, um die Backend-Antwort in Ihr gewünschtes Format zu ändern.

Amazon API Gateway kann in Ihrem Konto AWS Lambda-Funktionen ausführen, AWS Step Functions-Zustandsautomaten starten oder HTTP-Endpunkte aufrufen, die unter AWS Elastic Beanstalk oder Amazon EC2 gehostet werden, sowie nicht unter AWS gehostete, HTTP-basierte Vorgänge aufrufen, auf die über das öffentliche Internet zugegriffen werden kann. API Gateway gestattet Ihnen außerdem, eine Zuweisungsvorlage anzugeben, um statische Inhalte für die Rückgabe zu generieren, die Ihnen helfen, Ihre APIs zu simulieren, bevor das Backend bereit ist. Es besteht auch die Möglichkeit, API Gateway direkt in andere AWS-Services zu integrieren. Sie können beispielsweise eine API-Methode in API Gateway bereitstellen, mit der Daten direkt an Amazon Kinesis gesendet werden.

API Gateway generiert spezielle SDKs für die Entwicklung von Mobil-Apps mit Android bzw. iOS (Swift und Objective-C) und die Web-App-Entwicklung mit JavaScript. Das Generieren von SDKs für Ruby und Java wird von API Gateway ebenfalls unterstützt. Sobald eine API und ihre Modelle in API Gateway definiert sind, können Sie die AWS-Konsole oder die API Gateway-APIs verwenden, um ein Client-SDK zu generieren und herunterzuladen. Client SDKs werden nur für REST-APIs in Amazon API Gateway generiert.

Um zu erfahren, wo HTTP-APIs, REST-APIs und WebSocket-APIs verfügbar sind, sehen Sie sich hier die AWS-Regionstabelle an.

Über die Amazon API Gateway-Konsole können Sie die REST-API und ihre zugeordneten Ressourcen und Methoden definieren, den API-Lebenszyklus verwalten, Client-SDKs generieren und API-Metriken anzeigen. Sie können die API Gateway-Konsole auch verwenden, um die Nutzungspläne Ihrer APIs zu definieren, die API-Schlüssel von Entwicklern zu verwalten und die Einschränkung der maximalen Bandbreite sowie Quotenlimits zu konfigurieren. Die gleichen Aktionen sind über die API Gateway-APIs verfügbar.

Eine Ressource ist ein typisiertes Objekt, das Teil der Domain Ihrer API ist. Jeder einzelnen Ressource können ein Datenmodell sowie Beziehungen zu anderen Ressourcen zugeordnet werden und sie kann auf verschiedene Methoden antworten. Sie können Ressourcen auch als Variablen zum Abfangen von Anfragen an mehrere untergeordnete Ressourcen definieren.

Jede Ressource innerhalb einer REST API kann eine oder mehrere standardmäßige HTTP-Methoden unterstützen. Sie definieren, welche Verben für jede einzelne Ressource unterstützt werden sollen (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS) sowie deren Implementierung. Zum Beispiel sollte ein GET für die Ressource "Cars" eine Liste mit Autos zurückgeben. Um alle Methoden innerhalb einer Ressource mit einem einzelnen Backend-Endpunkt zu verbinden, unterstützt API Gateway auch eine spezielle ANY-Methode.

Nutzungspläne helfen Ihnen bei der Deklaration von Plänen für externe Entwickler, die den Zugriff auf bestimmte APIs einschränken, die Einschränkung der maximalen Bandbreite und Quotenlimits für Anforderungen definieren und sie mit API-Schlüsseln verknüpfen. Außerdem können Sie Nutzungsdaten pro API-Schlüssel extrahieren, um die API-Nutzung zu analysieren und Fakturierungsdokumente zu generieren. Sie können beispielsweise Basispläne, Profipläne und Unternehmenspläne erstellen. Sie könnten den Basisplan für die Nutzung so konfigurieren, dass nur 1 000 Anforderungen pro Tag und maximal fünf Anforderungen pro Sekunde erlaubt sind.

Bei Amazon API Gateway kann jede REST API mehrere Stufen haben. Stufen sollen im Entwicklungslebenszyklus einer API helfen. Wenn Sie zum Beispiel Ihre APIs aufgebaut und in einer Entwicklungsstufe bereitgestellt haben oder bereit für die Produktion sind, können Sie sie in einer Produktionsstufe bereitstellen.

Stufen in Amazon API Gateway sind ähnlich Tags. Sie definieren den Pfad, über den auf die Bereitstellung zugegriffen werden kann. Sie können beispielsweise Ihre Entwicklungsstufe definieren und Ihre API "cars" dort bereitstellen. Auf die Ressource kann dann über https://www.myapi.com/dev/cars zugegriffen werden. Sie können auch benutzerdefinierte Domain-Namen einrichten, die direkt auf eine Stufe verweisen, damit Sie nicht den zusätzlichen Pfadparameter zu verwenden brauchen. Wenn Sie beispielsweise myapi.com direkt auf die Stufe "dev" gerichtet haben, können Sie unter https://www.myapi.com/cars auf Ihre Ressource "cars" zugreifen. Stufen können mit Variablen konfiguriert werden, auf die aus Ihrer API-Konfiguration oder aus Zuweisungsvorlagen zugegriffen werden kann.

Mit Stufenvariablen können Sie Schlüssel-/Wert-Paare mit Konfigurationswerten definieren, die mit einer Stufe verbunden sind. Diese Werte können – ähnlich wie Umgebungsvariablen – in Ihrer API-Konfiguration verwendet werden. Sie könnten beispielsweise den HTTP-Endpunkt für Ihre Methodenintegration als Stufenvariable definieren und die Variable in Ihrer API-Konfiguration benutzen, anstatt den Endpunkt fix zu kodieren. Dies ermöglicht es Ihnen, einen anderen Endpunkt für jede Stufe (z. B. Entwicklung, Betaversion, Produktionsversion) zu verwenden. Die Stufenvariablen sind auch in den Zuweisungsvorlagen zugänglich und können genutzt werden, um Konfigurationsparameter Ihrem Lambda oder HTTP-Backend zu übergeben.

Eine Ressourcenrichtlinie ist ein an eine API angefügtes JSON-Richtliniendokument, mit dem gesteuert wird, ob ein bestimmter Principal (üblicherweise ein IAM-Benutzer oder eine IAM-Rolle) die API aufrufen darf. Sie können eine Ressourcenrichtlinie dazu verwenden, Benutzern eines anderen AWS-Kontos einen sicheren Zugriff auf Ihre API zu gewähren oder die API so einzurichten, dass sie nur von bestimmten IP-Adressbereichen bzw. CIDR-Blocks aufgerufen werden kann. Resourcenrichtlinien können mit REST APIs in Amazon API Gateway verwendet werden.

Amazon API Gateway speichert den Verlauf Ihrer Bereitstellungen. Sie können zu jedem beliebigen Zeitpunkt über Amazon API Gateway-APIs oder die Konsole eine Stufe auf eine frühere Bereitstellung zurücksetzen.

Ja. Sie können unser Open Source-Swagger-Import-Tool verwenden, um Ihre Swagger-API-Definitionen in Amazon API Gateway zu importieren. Mit dem Swagger-Import-Tool können Sie sowohl neue APIs erstellen und bereitstellen, als auch bestehende APIs aktualisieren.

Sie können Ihre APIs im API-Gateway durch Veröffentlichung als Produkte im AWS Marketplace monetarisieren. Zunächst müssen Sie sich im AWS Marketplace als Verkäufer registrieren und Ihren Nutzungspläne im API-Gateway als Produkte übermitteln. Hier finden Sie weitere Informationen zu API-Monetarisierung.

API Gateway bietet die Möglichkeit, eine Dokumentation zu den einzelnen Teilen Ihrer API, wie etwa Methoden und Ressourcen, zu erstellen, zu aktualisieren und zu löschen. Sie können auf dokumentationsbezogene APIs über die AWS-SDKs, die CLI, RESTful-Aufrufe oder durch Bearbeiten der Dokumentationszeichenfolgen direkt in der API Gateway-Konsole zugreifen. Eine Dokumentation kann auch als Swagger-Datei importiert werden – entweder als Teil der API oder separat, sodass Sie die Dokumentation ohne Auswirkung auf die API-Definition hinzufügen oder aktualisieren können. API Gateway entspricht der Open-API-Spezifikation für Dokumentationen, die in oder aus Swagger-Dateien importiert bzw. exportiert werden. Dokumentation wird unterstützt für REST APIs in API Gateway.

API Gateway unterstützt zusätzlich zur Standards-konformen API-Dokumentation die Dokumentationsvererbung, was das einmalige Definieren einer Dokumentationszeichenfolge und das darauf folgende Verwenden dieser Zeichenfolge an mehreren Orten vereinfacht. Die Vererbung vereinfacht den Prozess des Definierens der API-Dokumentation und kann in die Standarddarstellung konvertiert werden, wenn die API als Swagger-Datei exportiert wird.

Ja. Sie können eine Ressourcenrichtlinie auf eine API anwenden, um den Zugriff auf eine bestimmte Amazon VPC oder einen VPC-Endpunkt zu beschränken. Durch die Anwendung einer Ressourcenrichtlinie können Sie auch einer Amazon VPC oder einem VPC-Endpunkt aus einem anderen Konto den Zugriff auf die private API ermöglichen.