RESTAPIsIn API Gateway bereitstellen - APIAmazon-Gateway

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

RESTAPIsIn API Gateway bereitstellen

Nachdem Sie Ihre erstellt habenAPI, müssen Sie sie bereitstellen, damit sie von Ihren Benutzern aufgerufen werden kann.

Um eine bereitzustellenAPI, erstellen Sie eine API Bereitstellung und ordnen sie einer Phase zu. Eine Phase ist ein logischer Verweis auf Ihren Lebenszyklusstatus API (z. B.dev,prod,beta,v2). APIPhasen werden durch die API ID und den Phasennamen identifiziert. Sie sind in der enthaltenURL, mit der Sie die API aufrufen. Jede Phase ist ein benannter Verweis auf eine Bereitstellung von API und wird Client-Anwendungen zum Aufrufen zur Verfügung gestellt.

Wichtig

Jedes Mal, wenn Sie eine aktualisierenAPI, müssen Sie API sie in einer vorhandenen Phase oder in einer neuen Phase erneut bereitstellen. Das Aktualisieren von API umfasst das Ändern von Routen, Methoden, Integrationen, Autorisierern, Ressourcenrichtlinien und allem anderen als den Stufeneinstellungen.

Wenn sich Ihr API System weiterentwickelt, können Sie es weiterhin in verschiedenen Phasen als verschiedene Versionen von bereitstellen. API Sie können Ihre API Updates auch als Canary-Release-Bereitstellung bereitstellen. Auf diese Weise können Ihre API Kunden in derselben Phase auf die Produktionsversion über die Produktionsversion und über die Canary-Version auf die aktualisierte Version zugreifen.

Um eine bereitgestellte Datei aufzurufenAPI, sendet der Client eine Anfrage gegen eineAPI. URL Das URL wird durch das Protokoll ((S) oder HTTP (WSS)), den Hostnamen, den Staging-Namen und (für RESTAPIs) den Ressourcenpfad eines API Benutzers bestimmt. Der Hostname und der Name der Phase bestimmen die Basis API von. URL

Unter Verwendung API des Standard-Domainnamens von hat die Basis URL von REST API (zum Beispiel) in einer bestimmten Stufe ({stageName}) das folgende Format:

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

Um die API Standardbasis URL benutzerfreundlicher zu gestalten, können Sie einen benutzerdefinierten Domainnamen (z. B.api.example.com) erstellen, der den Standard-Hostnamen von ersetzt. API Um mehrere Versionen APIs unter dem benutzerdefinierten Domainnamen zu unterstützen, müssen Sie eine API Stufe einem Basispfad zuordnen.

Wenn der benutzerdefinierte Domänenname {api.example.com} und die API Stufe einem Basispfad von ({basePath}) unter dem benutzerdefinierten Domänennamen zugeordnet ist, REST API wird die Basis URL von a wie folgt:

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

Für jede Phase können Sie die API Leistung optimieren, indem Sie die Standardgrenzwerte für die Drosselung von Anfragen auf Kontoebene anpassen und das Caching aktivieren. API Sie können auch die Protokollierung für API Aufrufe an CloudTrail oder aktivieren und ein Client-Zertifikat für das Backend auswählen CloudWatch, um die Anfragen zu authentifizieren. API Darüber hinaus können Sie Einstellungen auf Stufenebene für einzelne Methoden überschreiben und Stufenvariablen definieren, um phasenspezifische Umgebungskontexte zur Laufzeit an die Integration zu übergeben. API

Stages ermöglichen eine robuste Versionskontrolle Ihrer. API Sie können beispielsweise eine API Stufe und eine test Phase bereitstellen und die prod test Phase als Testbuild und die prod Phase als stabilen Build verwenden. Nachdem die Aktualisierungen den Test bestanden haben, können Sie die test-Stufe auf prod hochstufen. Die Heraufstufung kann erfolgen, indem Sie den Wert API für die prod Stufe erneut bereitstellen oder den Wert einer Stufenvariablen vom Phasennamen von test auf den Wert von aktualisieren. prod

In diesem Abschnitt wird erläutert, wie eine mithilfe der APIGateway-Konsole oder API durch Aufrufen des APIGateways REST API bereitgestellt wird. Informationen zur Verwendung anderer Tools finden Sie in der Dokumentation von AWS CLIoder an AWS SDK.