Tutorial: Creación de una API de REST con una integración privada - Amazon API Gateway
Paso 1: crear un Servicio Amazon ECSPaso 2: crear un enlace de VPCPaso 3: Crear una API de RESTPaso 4: probar la APIPaso 5: implemente su APIPaso 6: llamar a la APIPaso 7: limpiar

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

En este tutorial, se crea una API de REST que se conecta a un servicio de Amazon ECS que se ejecuta en una Amazon VPC. Los clientes fuera de su VPC de Amazon pueden utilizar la API para acceder al Servicio Amazon ECS.

Para completar este tutorial se necesita aproximadamente una hora. En primer lugar, utilice una plantilla de CloudFormation para crear una nube de Amazon VPC y un servicio Amazon ECS. Luego, utilice la consola de API Gateway para crear un enlace de VPC V2. El vínculo VPC permite a API Gateway acceder al Servicio Amazon ECS que se ejecuta en su Amazon VPC A continuación, se crea una API de REST que utilice el enlace de VPC V2 para conectarse al servicio de Amazon ECS. Por último, se prueba la API.

Al invocar la API de REST, API Gateway envía la solicitud al servicio de Amazon ECS a través del enlace de VPC V2 y, a continuación, devuelve la respuesta del servicio.

nota

Anteriormente, este tutorial era compatible con las API HTTP y ahora lo es con las API de REST que utilizan el enlace de VPC V2.

Información general de la API de REST creada en este tutorial.

Para completar este tutorial, necesita una cuenta de AWS y un usuario de AWS Identity and Access Management con acceso a la consola. Para obtener más información, consulte Configuración para usar API Gateway.

Paso 1: crear un Servicio Amazon ECS

Amazon ECS es un servicio de administración de contenedores que le facilita la tarea de ejecutar, detener y administrar contenedores de Docker en un clúster. En este tutorial, ejecute el clúster en una infraestructura sin servidor administrada por Amazon ECS.

Descargue y descomprima esta plantilla de CloudFormation que crea todas las dependencias del servicio, incluida una nube de Amazon VPC. Utilice la plantilla para crear un Servicio Amazon ECS que utilice un Application Load Balancer.

Para crear una pila de CloudFormation

  1. Abra la consola de CloudFormation en https://console.aws.amazon.com/cloudformation.

  2. Seleccione Create stack (Crear pila) y, a continuación, seleccione With new resources (standard) (Con nuevos recursos [estándar]).

  3. En Specify template (Especificar plantilla), elija Upload a template file (Cargar un archivo de plantilla).

  4. Seleccione la plantilla que ha descargado.

  5. Elija Next (Siguiente).

  6. En Stack name (Nombre de pila), escriba rest-api-private-integrations-tutorial y, a continuación, elija Next (Siguiente).

  7. En Configure stack options (Configurar opciones de pila), elija Next (Siguiente).

  8. Para Capabilities (Capacidades), sepa que CloudFormation puede crear recursos de IAM en su cuenta.

  9. Elija Siguiente y, a continuación, elija Enviar.

CloudFormation aprovisiona al Servicio ECS. Puede tardar unos minutos. Cuando el estado de la pila de CloudFormation sea CREATE_COMPLETE, estará listo para continuar con el paso siguiente.

Un enlace de VPC permite a API Gateway acceder a recursos privados en una Amazon VPC Utilice un enlace de VPC para permitir a los clientes acceder al servicio de Amazon ECS a través de la API de REST.

Para crear un enlace de VPC

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

  2. En el panel de navegación principal, elija Enlaces de VPC y, a continuación, elija Crear.

    Es posible que necesite elegir el icono del menú para abrir el panel de navegación principal.

  3. En Elegir una versión de enlace de VPC, seleccione Enlace de VPC V2.

  4. En Name (Nombre) escriba private-integrations-tutorial.

  5. En VPC, elija la VPC que ha creado en el paso 1. El nombre debe empezar por RestApiStack.

  6. En Subnets (Subredes), seleccione las dos subredes privadas de la VPC. Los nombres terminan en PrivateSubnet.

  7. Para Grupos de seguridad, seleccione el ID de grupo que comience por private-integrations-tutorial y tenga la descripción RestApiStack/RestApiTutorialService/Service/SecurityGroup.

  8. Seleccione Crear.

Después de crear el enlace de VPC V2, API Gateway aprovisiona las interfaces de red elásticas para acceder a la VPC. El proceso puede demorar unos minutos. Mientras tanto, puede crear su API.

Paso 3: Crear una API de REST

La API de REST proporciona un punto de conexión HTTP para el servicio de Amazon ECS.

Para crear una API de REST

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

  2. Seleccione Create API (Crear API)y, a continuación, para API REST, seleccione Build (Construir).

  3. En Nombre, escriba private-integration-api.

  4. En Tipo de dirección IP, seleccione IPv4.

  5. Seleccione Crear API.

    Después de crear la API, se crea un método.

  6. 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. Para el enlace de la VPC, elija el enlace de VPC V2 que creó en el paso anterior.

    6. En Objetivo de integración, ingrese el equilibrador de carga que creó con la plantilla de CloudFormation en el paso 1. Su nombre debe empezar por rest-.

    7. En URL del punto de conexión, introduzca http://private-integrations-tutorial.com.

      La URL se utiliza para definir el encabezado Host de la solicitud de integración. En este caso, el encabezado del host es private-integrations-tutorial.

    8. Elija Crear método.

      Con la integración del proxy, la API está lista para probarse.

Paso 4: probar la API

A continuación, se prueba a invocar el método de la API.

Para probar la API

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

  2. Elija la API.

  3. Elija la pestaña Prueba. Puede que tenga que elegir el botón de flecha hacia la derecha para mostrar la pestaña.

  4. Seleccione Probar

    Compruebe que la respuesta de la API sea un mensaje de bienvenida que le indique que su aplicación se está ejecutando en Amazon ECS.

Paso 5: implemente su API

A continuación, debe implementar la API.

Para implementar su API

  1. Elija Implementar API.

  2. En Etapa, seleccione Nueva etapa.

  3. En Stage name (Nombre de etapa), escriba Prod.

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

  5. Elija Implementar.

Paso 6: llamar a la API

Después de implementar la API, puede llamarla.

Llamada a la API

  1. Ingrese la URL de invocación en un navegador web.

    La URL completa debería ser https://abcd123.execute-api.us-east-2.amazonaws.com/Prod.

    Su navegador envía una GET solicitud a la API.

  2. Compruebe que la respuesta de la API sea un mensaje de bienvenida que le indique que su aplicación se está ejecutando en Amazon ECS.

    Si ve el mensaje de bienvenida, ha creado correctamente un servicio de Amazon ECS que se ejecuta en una Amazon VPC y ha utilizado una API de REST de API Gateway con un enlace de VPC V2 para acceder al servicio de Amazon ECS.

Paso 7: limpiar

Para evitar costos innecesarios, elimine los recursos creados como parte de este tutorial Los pasos siguientes eliminan el enlace de VPC V2, la pila de CloudFormation y la API de REST.

Para eliminar una API REST

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

  2. En la página API, seleccione una API. Elija Action (Acciones), elija Delete (Eliminar)y, a continuación, confirme su elección.

Para eliminar un enlace de VPC

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

  2. Elija VPC link (Enlace de VPC).

  3. Seleccione el enlace de VPC, elija Delete (Eliminar)y, a continuación, confirme su elección.

Para eliminar una pila de CloudFormation

  1. Abra la consola de CloudFormation en https://console.aws.amazon.com/cloudformation.

  2. Seleccione su pila de CloudFormation.

  3. Elija Delete (Eliminar) y, a continuación, confirme su elección.