Erstellen Sie eine Bereitstellung für ein REST API API In-Gateway

In API Gateway wird eine REST API Bereitstellung durch eine Bereitstellungsressource repräsentiert. Es ähnelt einer ausführbaren Datei von einerAPI, die durch eine RestApiRessource repräsentiert wird.

Damit der Client Sie aufrufen kannAPI, müssen Sie eine Bereitstellung erstellen und ihr eine Phase zuordnen. Eine Stufe wird durch eine Stage-Ressource dargestellt. Es stellt eine Momentaufnahme der MethodenAPI, Integrationen, Modelle, Mapping-Vorlagen und Lambda-Autorisierer (früher bekannt als benutzerdefinierte Autorisierer) dar. Wenn Sie das aktualisieren, können Sie das erneut bereitstellenAPI, API indem Sie der vorhandenen Bereitstellung eine neue Phase zuordnen. Das Erstellen einer Stufe wird in beschriebe Richten Sie eine Bühne für ein REST API API In-Gateway ein.

Eine Bereitstellung auswählen

Die folgenden Verfahren zeigen, wie Sie eine Bereitstellung für eine erstellen. REST API

AWS Management Console

Sie müssen eine erstellt haben, REST API bevor Sie sie zum ersten Mal bereitstellen. Weitere Informationen finden Sie unter RESTAPIsIn API Gateway entwickeln.

Mit der API Gateway-Konsole können Sie eine bereitstellen, API indem Sie eine Bereitstellung erstellen und sie einer neuen oder vorhandenen Phase zuordnen.

1. Melden Sie sich unter https://console.aws.amazon.com/apigateway bei der API Gateway-Konsole an.

2. Wählen Sie im APIsNavigationsbereich die aus, die API Sie bereitstellen möchten.

3. Wählen Sie im Bereich Ressourcen die Option Bereitstellen ausAPI.

4. Wählen Sie für Stufe eine der folgenden Optionen aus:

   1. Um eine neue Stufe zu erstellen, wählen Sie Neue Stufe aus und geben Sie dann einen Namen in das Feld Stufenname ein. Optional können Sie unter Beschreibung der Bereitstellung eine Beschreibung für die Bereitstellung angeben.

   2. Um eine bestehende Stufe auszuwählen, wählen Sie den Namen der Stufe im Drop-down-Menü aus. Sie sollten unter Beschreibung der Bereitstellung eine Beschreibung der neuen Bereitstellung angeben.

   3. Um eine Bereitstellung zu erstellen, die keiner Stufe zugeordnet ist, wählen Sie Keine Stufe aus. Später können Sie diese Bereitstellung einer Stufe zuordnen.

5. Wählen Sie Bereitstellen.

AWS CLI

Wenn Sie eine Bereitstellung erstellen, instanziieren Sie die Deployment-Ressource. Sie können die API Gateway-Konsole, das AWS CLI AWS SDK, an oder das API Gateway verwenden, REST API um eine Bereitstellung zu erstellen.

Verwenden Sie den CLI Befehl create-deployment, um eine Bereitstellung zu erstellen:

 aws apigateway create-deployment --rest-api-id <rest-api-id> --region <region>

Der API kann erst aufgerufen werden, wenn Sie diese Bereitstellung einer Phase zuordnen. Diesen Vorgang können Sie bei einer bereits vorhandenen Stufe durch Aktualisieren der Eigenschaft deploymentId der Stufe mit der neu erstellten Bereitstellungs-ID (<deployment-id>) ausführen.

 aws apigateway update-stage --region <region> \
    --rest-api-id <rest-api-id> \ 
    --stage-name <stage-name> \ 
    --patch-operations op='replace',path='/deploymentId',value='<deployment-id>'

Bei API der ersten Bereitstellung können Sie die Erstellung der Phase und die Erstellung der Bereitstellung gleichzeitig kombinieren:

 aws apigateway create-deployment --region <region> \
    --rest-api-id <rest-api-id> \
    --stage-name <stage-name>

Dies geschieht hinter den Kulissen in der API Gateway-Konsole, wenn Sie eine API zum ersten Mal bereitstellen oder wenn Sie sie in einer neuen Phase erneut bereitstellen. API

Um eine erneut bereitzustellenAPI, führen Sie dieselben Schritte aus. Sie können dieselbe Stufe so oft wie gewünscht verwenden.

Die nächsten Schritte für Ihre Bereitstellung API

Im Folgenden finden Sie die nächsten Schritte für Ihre API Bereitstellung.

Ändern Sie die Einstellungen der Phase

Nach der Bereitstellung eines API können Sie die Staging-Einstellungen ändern, um den API Cache, die Protokollierung oder die Drosselung von Anfragen zu aktivieren oder zu deaktivieren. Sie können auch ein Client-Zertifikat für das Backend auswählen, um das API Gateway zu authentifizieren, und Stufenvariablen festlegen, um den Bereitstellungskontext zur Laufzeit an die API Integration zu übergeben. Weitere Informationen finden Sie unter Ändern Sie die Einstellungen der Phase.

Nachdem Sie die Stufeneinstellungen geändert haben, müssen Sie die erneut bereitstellen, API damit die Änderungen wirksam werden.

Anmerkung

Wenn die aktualisierten Einstellungen, wie z. B. das Aktivieren der Protokollierung, eine neue IAM Rolle erfordern, können Sie die erforderliche IAM Rolle hinzufügen, ohne die erneut bereitzustellen. API Es kann jedoch einige Minuten dauern, bis die neue IAM Rolle wirksam wird. Bevor das passiert, werden die Spuren Ihrer API Anrufe nicht protokolliert, auch wenn Sie die Protokollierungsoption aktiviert haben.

Wählen Sie verschiedene Kombinationen in der Bereitstellungsphase

Da eine Bereitstellung einen API Snapshot darstellt und eine Phase einen Pfad zu einem Snapshot definiert, können Sie verschiedene Kombinationen in der Bereitstellungsphase wählen, um zu steuern, wie Benutzer verschiedene Versionen von aufrufen. API Dies ist beispielsweise nützlich, wenn Sie einen Rollback API zu einer früheren Bereitstellung durchführen oder einen „privaten Zweig“ von mit dem API öffentlichen zusammenführen möchten.

Das folgende Verfahren zeigt, wie Sie dazu den Stage Editor in der API Gateway-Konsole verwenden. Es wird davon ausgegangen, dass Sie eine API mehr als einmal bereitgestellt haben müssen.

1. Wenn Sie sich noch nicht im Bereich Stufen befinden, wählen Sie im Hauptnavigationsbereich die Option Stufen aus.

2. Wählen Sie die Stufe aus, die Sie aktualisieren möchten.

3. Wählen Sie auf der Registerkarte Bereitstellungsverlauf die Bereitstellung aus, die die Stufe verwenden soll.

4. Wählen Sie Aktive Bereitstellung ändern.

5. Bestätigen Sie, dass Sie die aktive Bereitstellung ändern möchten, und wählen Sie Aktive Bereitstellung ändern im Dialogfeld Bereitstellung aktivieren aus.

Übergeben Sie bereitstellungsspezifische Daten an Ihre. API

Für eine Bereitstellung können Sie Stufenvariablen festlegen oder ändern, um bereitstellungsspezifische Daten zur Laufzeit an die API Integration zu übergeben. Sie können dies auf der Registerkarte Stage Variables im Stage Editor tun. Weitere Informationen finden Sie in den Anweisungen in Verwenden Sie Stufenvariablen für ein REST API API In-Gateway.