Bereitstellen einer REST-API in API Gateway - Amazon API 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.

Bereitstellen einer REST-API in API Gateway

In API Gateway wird eine REST-API-Bereitstellung durch eine Deployment-Ressource dargestellt. Sie ähnelt einer ausführbaren Datei einer API, die durch eine RestApi-Ressource dargestellt wird.

Damit der Client Ihre API aufrufen kann, müssen Sie eine Bereitstellung erstellten und ihr eine Stufe zuordnen. Eine Stufe wird durch eine Stage-Ressource dargestellt. Sie stellt einen Snapshot der API dar, einschließlich Methoden, Integrationen, Modellen, Mapping-Vorlagen und Lambda-Genehmigern (ehemals als benutzerdefinierte Genehmiger bezeichnet). Wenn Sie die API aktualisieren, können Sie sie erneut bereitstellen, indem Sie der vorhandenen Bereitstellung eine neue Stufe zuordnen. Das Erstellen einer Stufe wird in beschriebe Einrichten einer Stufe für eine REST-API.

Erstellen einer Bereitstellung mit der AWS CLI

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

Zum Erstellen einer Bereitstellung mit der CLI verwenden Sie den Befehl create-deployment:

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

Die API kann erst aufgerufen werden, wenn Sie dieser Bereitstellung eine Stufe zugeordnet haben. 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 der ersten Bereitstellung einer API können Sie die Stufe und die Bereitstellung gleichzeitig erstellen:

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

Dieser Vorgang wird im Hintergrund in der API Gateway-Konsole ausgeführt, wenn Sie eine API zum ersten Mal oder erneut für eine neue Stufe bereitstellen.