REST-APIs in API Gateway bereitstellen - Amazon API Gateway

REST-APIs in API Gateway bereitstellen

Nach der Erstellung der API müssen Sie diese bereitstellen, damit sie von den Benutzern aufgerufen werden kann.

Zum Bereitstellen einer API erstellen Sie eine API-Bereitstellung und verknüpfen sie mit einer Stufe. Eine Stufe ist ein logischer Verweis auf einen Lebenszyklusstatus Ihrer API (z. B, dev, prod, beta, v2). API-Stufen werden durch die API-ID und den Stufennamen identifiziert. Sie sind in der URL enthalten, die Sie zum Aufrufen der API verwenden. Jede Stufe ist ein benannter Verweis auf eine Bereitstellung der API und wird für Clientanwendungen zum Aufrufen zur Verfügung gestellt.

Wichtig

Jedes Mal, wenn Sie eine API aktualisieren, müssen Sie die API in einer vorhandenen Stufe oder in einer neuen Stufe erneut bereitstellen. Das Aktualisieren einer API umfasst das Ändern von Routen, Methoden, Integrationen, Genehmigern und allen anderen Details abgesehen von Stufeneinstellungen.

Wenn sich Ihre API erweitert, können Sie sie als unterschiedliche Versionen für verschiedene Stufen bereitstellen. Sie können Ihre API-Updates auch als Canary-Release-Bereitstellung bereitstellen. Auf diese Weise können Ihre API-Clients auf derselben Stufe über die Produktionsveröffentlichung auf die Produktionsversion und über die Canary-Veröffentlichung auf die aktualisierte Version zugreifen.

Zum Aufrufen einer bereitgestellten API sendet der Client eine Anforderung mit einer API-URL. Die URL wird anhand eines API-Protokolls (HTTP (S) oder (WSS)), Hostnamens, Stufennamens und (für REST-APIs) Ressourcen-Pfads bestimmt. Der Hostname und der Stufenname bestimmen die Basis-URL der API.

Unter Verwendung des Standarddomänennamens der API weist die Basis-URL einer REST-API (beispielsweise) in einer bestimmten Stufe ({stageName}) das folgende Format auf:

https://{restapi-id}.execute-api.{region}.amazonaws.com/{stageName}

Sie können einen benutzerdefinierten Domänennamen (z. B. api.example.com) erstellen und damit den standardmäßigen Hostnamen der API ersetzen, um die Basis-URL der API benutzerfreundlicher zu gestalten. Um mehrere APIs unter dem benutzerdefinierten Domänennamen zu unterstützen, müssen Sie einem Basispfad eine API-Stufe zuordnen.

Mit dem benutzerdefinierten Domänennamen {api.example.com} und der einem Basispfad ({basePath}) unter dem benutzerdefinierten Domänennamen zugeordneten API-Stufe, ändert sich die Basis-URL einer REST-API wie folgt: 

https://{api.example.com}/{basePath}

Sie können für jede Stufe die API-Leistung optimieren, indem Sie die standardmäßigen Drosselungslimits für Anforderungen auf Kontoebene anpassen und das API-Caching aktivieren. Sie können auch die Protokollierung für API-Aufrufe an CloudTrail oder CloudWatch aktivieren und ein Clientzertifikat für das Backend auswählen, um die API-Anforderungen zu authentifizieren. Außerdem können Sie die Stufeneinstellungen für einzelne Methoden überschreiben und Stufenvariablen definieren, um stufenbezogenen Umgebungskontext zur Laufzeit an die API-Integration zu übergeben.

Stufen ermöglichen eine robuste Versionskontrolle Ihrer API. Sie können beispielsweise eine API für eine test- und eine prod-Stufe bereitstellen und die test-Stufe als Test-Build und die prod-Stufe als stabilen Build verwenden. Nachdem die Aktualisierungen den Test bestanden haben, können Sie die test-Stufe auf prod hochstufen. Eine Hochstufung kann durch die erneute Bereitstellung der API auf der prod-Stufe oder durch Aktualisieren eines Stufenvariablenwerts vom Stufennamen test auf prod erfolgen.

In diesem Abschnitt wird die Bereitstellung einer API mithilfe der API Gateway-Konsole oder durch Aufrufen der API Gateway-REST-API beschrieben. Informationen zur Verwendung anderer Tools finden Sie in der Dokumentation der AWS CLI oder eines AWS SDK.

Themen