Implementación de una API de REST en API Gateway - Amazon API Gateway

Implementación de una API de REST en API Gateway

En API Gateway, la implementación de una API de REST se representa mediante un recurso Deployment. Es similar a un ejecutable de una API al cual representa un recurso RestAPI.

Para que el cliente pueda llamar a la API, debe crear una implementación y asociarle una etapa. Las etapas se representan mediante recursos Stage. Representa una instantánea de la API que incluye métodos, integraciones, modelos, plantillas de mapeo y autorizadores de Lambda (anteriormente conocidos como autorizadores personalizados). Cuando actualiza la API, puede implementarla de nuevo asociando una nueva etapa a la implementación existente. Explicaremos cómo se crea un etapa en Configuración de un escenario para una API de REST.

Creación de una implementación con la AWS CLI

Cuando se crea una implementación, se crea una instancia del recurso Deployment. Para crear una implementación, puede utilizar la consola de API Gateway, la AWS CLI, un AWS SDK o la API REST de API Gateway.

Si crea una implementación a través de la CLI, utilice el comando create-deployment:

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

La API no se puede invocar hasta que esta implementación se asocia a una etapa. Si ya hay una etapa, puede hacerlo actualizando la propiedad deploymentId de la etapa con el ID de implementación que acaba de crear (<deployment-id>).

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>'

Cuando se implementa una API por primer vez, la etapa y la implementación se pueden crear al mismo tiempo:

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

Esto es lo que ocurre en segundo plano en la consola de API Gateway cuando la API se implementa por primera vez o cuando se implementa en una nueva etapa.