Tutorial: Creación de una API de REST con una integración privada - Amazon API Gateway

Tutorial: Creación de una API de REST con una integración privada

Puede crear una API de API Gateway con integración privada para proporcionar a sus clientes acceso a recursos HTTP/HTTPS dentro de su Amazon Virtual Private Cloud (Amazon VPC). Estos recursos de VPC son puntos de enlace HTTP/HTTPS de una instancia EC2 situada detrás de un balanceador de carga de red de la VPC. El balanceador de carga de red encapsula el recurso de la VPC y direcciona las solicitudes entrantes al recurso correspondiente.

Cuando un cliente llama a la API, API Gateway se conecta al balanceador de carga de red a través del enlace de VPC preconfigurado. El recurso VpcLink de API Gateway encapsula un enlace de la VPC. Este es responsable de reenviar las solicitudes del método de API a los recursos de la VPC y devuelve las respuestas del backend al intermediario. Para los desarrolladores de API, VpcLink es funcionalmente equivalente a un punto de enlace de integración.

Para crear una API con integración privada, debe crear un nuevo VpcLink (o elegir uno existente) que esté conectado a un balanceador de carga de red que tenga como destino los recursos de la VPC deseados. Debe disponer de los permisos adecuados para crear y administrar un VpcLink. A continuación, deberá configurar un método de la API e integrarlo con VpcLink estableciendo HTTP o HTTP_PROXY como tipo de integración, VPC_LINK como tipo de conexión de integración y el identificador VpcLink en el campo connectionId de la integración.

nota

El equilibrador de carga de red y la API deben pertenecer a la misma cuenta de AWS.

Si desea empezar a crear rápidamente una API que tenga acceso a los recursos de la VPC, le guiaremos por los pasos esenciales para crear una API con integración privada a través de la consola de API Gateway. Antes de crear la API, haga lo siguiente:

  1. Cree un recurso de la VPC, cree o elija un balanceador de carga de red en una cuenta de la misma región y agregue la instancia EC2 que aloja el recurso como destino del balanceador de carga de red. Para obtener más información, consulte Configuración de un Network Load Balancer para integraciones privadas de API Gateway.

  2. Conceda los permisos necesarios para crear los enlaces VPC para integraciones privadas. Para obtener más información, consulte Concesión de permisos para API Gateway para crear un enlace de VPC.

Después de crear el recurso de VPC y el balanceador de carga de red con dicho recurso configurado en sus grupos de destino, siga las instrucciones que se indican a continuación para crear una API e integrarla con el recurso de la VPC a través de un VpcLink de una integración privada.

para crear una API con una integración privada

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

  2. Si es la primera vez que utiliza API Gateway, verá una página en la que aparecen las características del servicio. En REST API, elija Build (Compilación). Cuando aparezca el menú emergente Create Example API (Crear API de ejemplo), elija OK (Aceptar).

    Si esta no es la primera vez que utiliza API Gateway, elija Create API (Crear API). En REST API, elija Build (Compilación).

  3. Cree una API de REST regional u optimizada para la periferia.

  4. Seleccione la API.

  5. Elija Crear método y luego haga lo siguiente:

    1. En Tipo de método, seleccione GET.

    2. En Tipo de integración, seleccione Enlace de VPC.

    3. Active Integración de proxy de VPC.

    4. En Método HTTP, seleccione GET.

    5. En Enlace de VPC, seleccione [Usar variable de etapa] e introduzca ${stageVariables.vpcLinkId} en el cuadro de texto siguiente.

      Puede definir la variable de etapa vpcLinkId después de implementar la API en una etapa y establecer su valor en el ID del VpcLink.

    6. En URL de punto de conexión, introduzca una URL, por ejemplo, http://myApi.example.com.

      Aquí, utilizaremos el nombre de host (por ejemplo, myApi.example.com) para definir el encabezado Host de la solicitud de integración.

    7. Elija Crear método.

      Con la integración del proxy, la API está lista para implementarse. De lo contrario, debe configurar las respuestas del método y las respuestas de integración apropiadas.

  6. Elija Implementar API y, a continuación, haga lo siguiente:

    1. En Etapa, seleccione Nueva etapa.

    2. En Nombre de etapa, ingrese un nombre de etapa.

    3. (Opcional) En Description (Descripción), introduzca una descripción.

    4. Elija Implementar.

  7. En la sección Detalles de la etapa, anote la URL de la invocación resultante. Lo necesitará para invocar la API. Antes de eso, debe configurar la variable de etapa vpcLinkId.

  8. En el panel Etapas, seleccione la pestaña Variables de etapa y, a continuación, haga lo siguiente:

    1. Elija Administrar variables y, a continuación, elija Agregar variable de etapa.

    2. En Nombre, escriba vpcLinkId.

    3. En Valor, introduzca el ID de VPC_LINK; por ejemplo, gix6s7.

    4. Seleccione Guardar.

      Si utiliza la variable de etapa, podrá cambiar fácilmente entre los diferentes enlaces VPC de la API; solo tendrá que modificar el valor de esta variable.