Implementación de una API de REST desde la consola de API Gateway - Amazon API Gateway

Implementación de una API de REST desde la consola de API Gateway

Debe haber creado una API de REST antes de implementarla por primera vez. Para obtener más información, consulte Creación de una API REST en Amazon API Gateway.

Implementación de una API de REST en una etapa

La consola de API Gateway le permite implementar una API creando una implementación y asociándola a una etapa nueva o una existente.

nota

Para asociar una etapa en API Gateway con otra implementación, consulte Asociación de una etapa a otra implementación de una API de REST en su lugar.

  1. Inicie sesión en la consola de API Gateway en https://console.aws.amazon.com/apigateway.

  2. En el panel de navegación APIs, elija la API que desea implementar.

  3. En el panel Resources (Recursos), elija Deploy API (Implementar API).

  4. En Etapa, seleccione una de las siguientes opciones:

    1. Para crear una nueva etapa, seleccione Nueva etapa y, a continuación, ingrese un nombre en Nombre de la etapa. Si lo desea, puede proporcionar una descripción de la implementación en Descripción de la implementación.

    2. Para elegir una etapa existente, seleccione el nombre de la etapa en el menú desplegable. Es posible que desee proporcionar una descripción de la nueva implementación en Descripción de la implementación.

    3. Para crear una implementación que no esté asociada a una etapa, seleccione Sin etapa. Más adelante, puede asociar esta implementación a una etapa.

  5. Seleccione Implementar.

Reimplementación de una API de REST en una etapa

Para volver a implementar una API, realice los mismos pasos que en Implementación de una API de REST en una etapa. Puede volver a utilizar la misma etapa tantas veces como desee.

Actualización de la configuración de etapas de una implementación de una API de REST

Una vez que se implementa una API, puede modificar la configuración de las etapas para habilitar o deshabilitar el almacenamiento en caché, el registro o los límites de solicitudes de la API. También puede elegir un certificado de cliente para que el backend autentique a API Gateway y definir variables de etapa para pasar el contexto de implementación a la integración de la API en el tiempo de ejecución. Para obtener más información, consulte Actualización de la configuración de etapas.

importante

Después de modificar la configuración de la etapa, es necesario volver a implementar la API para que los cambios surtan efecto.

nota

Si la configuración actualizada, como habilitar el registro, requiere un nuevo rol de IAM, puede agregar el rol de IAM necesario sin tener que volver a implementar la API. No obstante, el nuevo rol de IAM puede tardar unos minutos en empezar a funcionar. Antes de que esto ocurra, los registros de seguimiento de las llamadas a la API no se registran aunque haya habilitado la opción de registro.

Establecimiento de variables de etapa para una implementación de una API de REST

Para una implementación, puede definir o modificar variables de etapa para pasar datos específicos de la implementación a la integración de la API en tiempo de ejecución. Puede hacer esto en la pestaña Stage Variables (Variables de etapa) en Stage Editor (Editor de etapas). Para obtener más información, consulte las instrucciones de Configuración de variables de etapa para una implementación de una API de REST.

Asociación de una etapa a otra implementación de una API de REST

Como una implementación representa una snapshot de API y una etapa define una ruta en una snapshot, puede elegir diferentes combinaciones de etapas de implementación para controlar la forma en que los usuarios llaman a diferentes versiones de la API. Esto resulta útil, por ejemplo, cuando desea restaurar el estado de la API a una implementación anterior o combinar una "ramificación privada" de la API con una pública.

El siguiente procedimiento muestra cómo hacer esto con el editor de etapas en la consola de API Gateway. Se supone que debe haber implementado una API más de una vez.

  1. Si aún no está en el panel Etapas, en el panel de navegación principal, elija Etapas.

  2. Seleccione la etapa que desea actualizar.

  3. En la pestaña Historial de implementación, seleccione la implementación que desea que utilice la etapa.

  4. Elija Cambiar implementación activa.

  5. Confirme que desea cambiar la implementación activa y elija Cambiar implementación activa en el cuadro de diálogo Crear implementación activa.