Modelo de implementación de API Gateway

Información acerca de los componentes de la API

Una API definida en API Gateway consta de dos componentes principales:

  1. API config: La configuración de API que se crea cuando subes una definición de API. Crearás la definición de la API como una especificación de OpenAPI. Si tu API administra servicios de gRPC en Cloud Run, puedes definirla con una configuración y una definición de servicio de gRPC.

    Cada vez que subes una definición de API, API Gateway crea una nueva configuración de API. Es decir, puedes crear una configuración de API, pero no puedes modificarla más adelante. Si luego editas la definición de la API en la especificación de OpenAPI o la definición del servicio de gRPC y, luego, subes la definición editada de la API, debes crear una nueva configuración de API.

  2. Gateway: Es un proxy escalable de alto rendimiento basado en Envoy que aloja la configuración de la API implementada. Cuando implementas una configuración de API en una puerta de enlace, se crea la URL externa que tus clientes de API utilizan para acceder a la API.

En la siguiente imagen, se muestran estos componentes:

En la definición de la API en el panel de API Gateway, se muestran tres componentes de configuración de API y tres componentes de la puerta de enlace.

Acerca de la implementación de una configuración de API en una puerta de enlace

Implementa una configuración de API en una puerta de enlace para que tus clientes de API puedan acceder a la API:

En tres APIs de muestra, se implementa una configuración de API en una puerta de enlace, lo que hace que los clientes de la API puedan acceder a las APIs.

Una puerta de enlace:

  • Se implementa en una región de GCP específica. Una región es una región geográfica específica en GCP en la que puedes implementar recursos.

  • Debe alojar una configuración de API. No puedes crear una puerta de enlace vacía, es decir, una sin una configuración de API. Sin embargo, después de crear una puerta de enlace, puedes actualizarla para reemplazar una configuración de API por otra.

  • Solo se puede alojar una única configuración de API. No puedes implementar varios parámetros de configuración de API en la misma puerta de enlace.

Luego, administras cada puerta de enlace implementada por separado. Para cada puerta de enlace, puedes hacer lo siguiente:

  • Iniciar, detener o borrar la puerta de enlace
  • Visualiza registros y métricas
  • Visualiza información de seguimiento

Elige una región de GCP

Cada puerta de enlace se implementa en una región geográfica específica en GCP. API Gateway admite las siguientes regiones de GCP para la implementación:

  • asia-northeast1
  • australia-southeast1
  • europe-west1
  • europe-west2
  • us-east1
  • us-east4
  • us-central1
  • us-west2
  • us-west3
  • us-west4

La compatibilidad con las puertas de enlace de API Gateway creadas anteriormente en asia-east1 finalizará el 1 de noviembre de 2022. Debes revisar las puertas de enlace que se ejecutan actualmente en asia-east1 y borrarlas o volver a crearlas en una ubicación nueva según sea necesario.

Define el extremo de la configuración de la API implementada

Cuando implementas una configuración de API en una puerta de enlace, API Gateway crea una URL única para la puerta de enlace en el dominio gateway.dev. Luego, los clientes de la API usarán una URL con el siguiente formato para acceder a la configuración de la API implementada:

https://GATEWAY_ID-HASH.REGION_CODE.gateway.dev

donde:GATEWAY_ID es el nombre de la puerta de enlace, HASH es el código hash único generado cuando se implementó la API y REGION_CODE es el código de la región de GCP en la que implementaste la puerta de enlace.

Por ejemplo:

my-gateway-a12bcd345e67f89g0h.uc.gateway.dev

Configura una cuenta de servicio para implementar los parámetros de configuración de la API

Una configuración de API implementada en una puerta de enlace se ejecuta con los permisos asociados con las funciones otorgadas a la cuenta de servicio que se usó para crear la configuración de la API. Por lo tanto, en general, definirás una cuenta de servicio separada para crear los parámetros de configuración de la API. Esa cuenta de servicio se asigna solo a los roles necesarios para acceder al servicio de backend. De esta manera, puedes limitar los permisos asociados con la configuración de la API.

Además de los roles necesarios para acceder al servicio de backend, la cuenta de servicio debe tener los siguientes permisos:

  • El permiso iam.serviceAccounts.actAs. Este permiso se incluye en la función de usuario de cuenta de servicio.

  • Los permisos necesarios para acceder a tu servicio de backend Por ejemplo, si tu backend se implementa como una Cloud Function, la cuenta de servicio debe, como mínimo, estar asignada a la función de Invocador de Cloud Functions. La función de un backend de Cloud Run es Invocador de Cloud Run. Si limitas los permisos asociados con la configuración de la API, puedes proteger mejor tus sistemas de backend.

Consulta Cómo configurar el entorno de desarrollo para obtener más información.

Información acerca de la reducción de escala a cero

API Gateway es un servicio de escala a cero. Esto significa que cuando no hay tráfico, se borran todas las instancias de puerta de enlace. Cuando aumenta el tráfico, se crean instancias nuevas a pedido para controlar la carga. GCP controla automáticamente la escala a cero; no es necesario que la configures ni la administres.

Usa un balanceador de cargas

Cada puerta de enlace implementada en una región contiene un balanceador de cargas integrado para administrar las solicitudes de los clientes a la API implementada en la puerta de enlace. No es necesario que crees un balanceador de cargas independiente para cada puerta de enlace.

Debes crear un balanceador de cargas cuando implementes la misma API en puertas de enlace ubicadas en diferentes regiones. Luego, el balanceador de cargas dirige las solicitudes a la API a las diferentes regiones. Consulta Cómo implementar una API en varias regiones a continuación para obtener más información.

Configura el acceso SSL a una API

API Gateway admite el acceso HTTPS a una API implementada en una puerta de enlace. Debido a que tus API se implementan en el dominio gateway.dev, Google crea y administra el certificado SSL en el balanceador de cargas integrado en la puerta de enlace. No es necesario que crees ni subas tu propio certificado.

Cómo configurar un servidor de nombres de dominio

De forma predeterminada, los clientes de la API realizan solicitudes a un dominio gateway.dev para acceder a una API implementada, como se muestra arriba.

Los nombres de dominio personalizados son para API Gateway cuando se usan junto con el balanceo de cargas HTTP(S) para API GatewayPREVIEW. Para personalizar el nombre de dominio, crea un balanceador de cargas a fin de usar tu nombre de dominio personalizado y, luego, dirige las solicitudes al dominio gateway.dev de la API implementada. Para obtener más información, consulta Cómo usar un dominio personalizado con API Gateway.

Implementa varios parámetros de configuración de API en la misma API

Solo puedes implementar una configuración de API en una puerta de enlace. Sin embargo, puedes implementar varios parámetros de configuración de API en varias puertas de enlace dentro de la misma API.

En esta sección, se describen dos situaciones en las que podrías implementar varios parámetros de configuración de API en varias puertas de enlace dentro de una sola API.

Implementa la configuración de la API en varias puertas de enlace en la misma región

Cuando compilan una API, los desarrolladores de API suelen crear entornos de desarrollo, etapa de pruebas y producción, en los que sucede lo siguiente:

  • Los desarrolladores usan el entorno de development para crear la API.
  • El entorno de etapa de pruebas se usa para probar la API como preparación para un lanzamiento en producción.
  • El entorno de production es donde los clientes de la API externa pueden acceder a la API.

Para admitir este tipo de entorno de desarrollo, debes definir varios parámetros de configuración de API. Por ejemplo, es posible que tengas varios parámetros de configuración de API actualmente en desarrollo, una configuración de API que se está probando en la etapa de pruebas y una que se implementa actualmente en producción.

API Gateway te permite crear varias configuraciones de API dentro de una sola API y, luego, implementar cada configuración de API en una puerta de enlace diferente:

En la API 1, se implementan tres configuraciones de API, API Config Dev, API Config Stage y API Config Prod, en tres puertas de enlace respectivas.

En este ejemplo, tienes tres configuraciones de API diferentes: dev, stage y prod. Luego, implementas cada configuración de API en una puerta de enlace diferente, en la que cada puerta de enlace define su propia URL de extremo única.

Implementa una configuración de API en varias regiones

A menudo, se implementa una API en varias regiones de GCP. La implementación en varias regiones ofrece varias ventajas, como una menor latencia de solicitudes, ya que las solicitudes se dirigen a una API que se ejecuta en una región geográficamente cercana al cliente, y una confiabilidad mejorada, ya que una falla en una región no afecta a las APIs que se ejecutan en otras regiones.

Para implementar una API en varias regiones, debes implementar una configuración de API en una puerta de enlace en cada región. Cada configuración de API es específica de la región implementada porque debe hacer referencia al servicio de backend en esa región.

En la siguiente imagen, las APIs 1 y 2 se implementan en una sola región, y la API 3 se implementa en varias regiones:

La API 1 y la API 2 se implementan en la región 1, y la API 3 se implementa en la región 1, la región 2 y la región 3 mediante un balanceador de cargas.

En este ejemplo, cada configuración de API implementada en una puerta de enlace para la API 3 tiene un extremo de URL único, con el siguiente formato:

https://my-gateway1-a12bcd345e67f89g0h.uc.gateway.dev
https://my-gateway2-b12cde345f67g89h0i.en.gateway.dev
https://my-gateway3-c12bde345g67h89i0j.uw.gateway.dev

Luego, configura un balanceador de cargas mediante el balanceo de cargas de HTTP(S) para API Gateway PREVIEW a fin de controlar las solicitudes a la API y reenviar la solicitud a la región adecuada. Si deseas obtener más información, consulta Crea implementaciones multirregionales para API Gateway.

Actualiza una API

Para actualizar una API implementada, edita la definición de la API en la especificación de OpenAPI y, luego, sube la especificación. Cuando subes una especificación nueva, se crea una configuración de API nueva.

API Gateway admite un modelo de actualización sin tiempo de inactividad, lo que significa que tu API continúa controlando las solicitudes durante la implementación de la configuración actualizada de la API. Sin embargo, hay un período mientras se implementa la configuración de la API nueva en el que es posible que la versión anterior de la configuración de la API controle algunas solicitudes.

Si implementaste la configuración de la API en varias regiones y puertas de enlace, debes volver a implementar la configuración de la API actualizada en cada región por separado.

¿Qué sigue?