Bereitstellen einer REST-API über die API Gateway-Konsole

Sie müssen eine REST API erstellt haben, bevor Sie sie erstmals bereitstellen können. Weitere Informationen finden Sie unter REST-API in Amazon API Gateway erstellen.

Bereitstellen einer REST-API für eine Stufe

Mit der API Gateway-Konsole können Sie eine API bereitstellen, indem Sie eine Bereitstellung erstellen und sie mit einer neuen oder bestehenden Stufe verknüpfen.

Anmerkung

Informationen zum Verknüpfen einer Stufe in API Gateway mit einer anderen Bereitstellung finden Sie stattdessen unter Zuweisen einer Stufe mit einer anderen REST-API-Bereitstellung.

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

2. Wählen Sie im APIs-Navigationsbereich die API, die Sie bereitstellen möchten.

3. Wählen Sie im Bereich Ressourcen die Option API bereitstellen aus.

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 aus.

Erneutes Bereitstellen einer REST-API für eine Stufe

Um eine API erneut bereitzustellen, führen Sie die gleichen Schritte wie in au Bereitstellen einer REST-API für eine Stufe. Sie können dieselbe Stufe so oft wie gewünscht verwenden.

Aktualisieren der Stufenkonfiguration einer REST-API-Bereitstellung

Nachdem eine API bereitgestellt wurde, können Sie die Stufeneinstellungen ändern, um den API-Cache, die Protokollierung oder die Anforderungsdrosselung zu aktivieren oder zu deaktivieren. Sie können auch ein Client-Zertifikat wählen, damit das Backend API Gateway authentifizieren und Stufenvariablen festlegen kann, um den Bereitstellungskontext während der Laufzeit an die API-Integration zu übergeben. Weitere Informationen finden Sie unter Aktualisieren von Stufeneinstellungen.

Wichtig

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

Anmerkung

Wenn die aktualisierten Einstellungen, wie die Aktivierung der Protokollierung, eine neue IAM-Rolle erfordern, können Sie die erforderliche IAM-Rolle ohne erneute Bereitstellung der API hinzufügen. Allerdings kann es einige Minuten dauern, bis die neue IAM-Rolle wirksam wird. Bevor dies jedoch der Fall ist, werden Spuren Ihrer API-Aufrufe nicht protokolliert, auch wenn Sie die Protokollierung aktiviert haben.

Einrichten von Stufenvariablen für eine REST-API-Bereitstellung

Für eine Bereitstellung können Sie Stufenvariablen so festlegen oder ändern, dass bereitstellungsspezifische Daten während der Laufzeit an die API-Integration weitergeben werden. Sie können dies auf der Registerkarte Stage Variables im Stage Editor tun. Weitere Informationen finden Sie in den Anweisungen in Einrichten von Stufenvariablen für eine REST-API-Bereitstellung.

Zuweisen einer Stufe mit einer anderen REST-API-Bereitstellung

Da eine Bereitstellung einen API-Snapshot darstellt und eine Stufe einen Pfad in einen Snapshot definiert, können Sie verschiedene Bereitstellungsstufen-Kombinationen wählen, um zu steuern, wie Benutzer verschiedene Versionen der API aufrufen. Dies ist beispielsweise nützlich, wenn Sie den API-Status auf eine frühere Bereitstellung zurücksetzen oder eine "private Zweigstelle" der API in eine öffentliche integrieren möchten.

Im folgenden Verfahren wird gezeigt, wie Sie dies mithilfe des Stage Editor (Stufen-Editor) in der API Gateway-Konsole tun. Es wird davon ausgegangen, dass Sie eine API mehr als einmal bereitgestellt haben.

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.