Primeros pasos con API Gateway y Cloud Run

En esta página, se muestra cómo configurar API Gateway para administrar y proteger un servicio de backend de Cloud Run.

Lista de tareas

Usa la siguiente lista de tareas mientras trabajas en el instructivo. Todas las tareas son necesarias a fin de implementar una API Gateway para tu servicio de backend de Cloud Run.

  1. Crea o selecciona un proyecto de Google Cloud.
  2. Si no has implementado tu propio Cloud Run, implementa un servicio de muestra. Ve el paso 7 en Antes de comenzar.
  3. Habilita los servicios de API Gateway necesarios.
  4. Crea una especificación de OpenAPI que describa tu API y configura las rutas al servicio de backend de Cloud Run. Consulta Crea una configuración de API.
  5. Implementa una API Gateway con tu configuración de API. Consulta Implementa una API Gateway.
  6. Realiza un seguimiento de la actividad de tus servicios. Consulta Cómo realizar un seguimiento de la actividad de la API.
  7. Evita que se generen cargos en tu cuenta de Google Cloud. Consulta Cómo realizar una limpieza.

Antes de comenzar

  1. En la consola de Google Cloud, ve a la página Panel y selecciona o crea un proyecto de Google Cloud.

    Ir a la página Panel

  2. Asegúrate de tener habilitada la facturación para tu proyecto.

    Aprende a habilitar la facturación

  3. Toma nota del ID del proyecto que deseas usar para este instructivo. En el resto de esta página, este ID del proyecto se denomina PROJECT_ID.

  4. Descarga y, luego, instala Google Cloud CLI.

    Descarga la CLI de gcloud

  5. Actualiza los componentes de gcloud:

    gcloud components update

  6. Configura el proyecto predeterminado. Reemplaza PROJECT_ID por el ID del proyecto de Google Cloud

    gcloud config set project PROJECT_ID

  7. Si no implementaste tu propio servicio de Cloud Run, sigue los pasos de la Guía de inicio rápido: Implementa un contenedor de muestra ya compilado para seleccionar o crear un proyecto de Google Cloud y, luego, implementar un backend de muestra. Toma nota de la URL de la aplicación, así como de la región y el ID del proyecto donde se implementan tus aplicaciones.

Habilita los servicios obligatorios

API Gateway requiere que habilites los siguientes servicios de Google:

Nombre Título
apigateway.googleapis.com API de API Gateway
servicemanagement.googleapis.com API de Service Management
servicecontrol.googleapis.com API de Service Control

Para confirmar que los servicios obligatorios están habilitados, haz lo siguiente:

gcloud services list

Si no ves los servicios necesarios que se incluyeron en la lista, habilítalos:

gcloud services enable apigateway.googleapis.com
gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com

Para obtener más información sobre los servicios de gcloud, consulta Servicios de gcloud.

Crea una configuración de API

Antes de que se pueda usar API Gateway para administrar el tráfico al backend de Cloud Run implementado, necesita una configuración de API.

Puedes crear una configuración de API con una especificación de OpenAPI que contenga anotaciones especializadas para definir el comportamiento deseado de API Gateway. Deberás agregar un campo específico de Google que contenga la URL de cada app de Cloud Run para que API Gateway tenga la información que necesita para invocar una app.

  1. Crea un archivo de texto denominado openapi2-run.yaml. Por conveniencia, esta página hace referencia a la especificación de OpenAPI mediante ese nombre de archivo, pero puedes nombrarlo de otra manera si lo prefieres.
  2. Enumera cada una de tus apps en la sección paths del archivo openapi2-run.yaml, como se muestra a continuación: 
    # openapi2-run.yaml
swagger: '2.0'
info:
  title: API_ID optional-string
  description: Sample API on API Gateway with a Cloud Run backend
  version: 1.0.0
schemes:
- https
produces:
- application/json
x-google-backend:
  address: APP_URL
paths:
  /assets/{asset}:
    get:
      parameters:
        - in: path
          name: asset
          type: string
          required: true
          description: Name of the asset.
      summary: Assets
      operationId: getAsset
      responses:
        '200':
          description: A successful response
          schema:
            type: string
  /hello:
    get:
      summary: Cloud Run hello world
      operationId: hello
      responses:
        '200':
          description: A successful response
          schema:
            type: string
  3. En el campo title, reemplaza API_ID por el nombre de tu API y reemplaza optional-string por una breve descripción de tu elección. Si tu API todavía no existe, el comando para crear la configuración de la API también creará la API con el nombre que especifiques. El valor del campo title se usa cuando se crean claves de API que otorgan acceso a esta API. Consulta los requisitos del ID de API para obtener lineamientos de nombres de API.
  4. En el campo address de la sección x-google-backend, reemplaza APP_URL por la URL real de tu servicio de Cloud Run (la ruta de acceso completa de la API llamada). Por ejemplo: https://hello-abc1def2gh-uc.a.run.app.
  5. Ingresa el siguiente comando, donde:
    • CONFIG_ID especifica el nombre de la configuración de tu API.
    • API_ID especifica el nombre de tu API. Si la API aún no existe, este comando la creará.
    • PROJECT_ID especifica el nombre del proyecto de Google Cloud.
    • SERVICE_ACCOUNT_EMAIL especifica la cuenta de servicio que se usa para firmar tokens para backends con autenticación configurada. Para obtener más información, consulta Crea una cuenta de servicio. 
    gcloud api-gateway api-configs create CONFIG_ID \
  --api=API_ID --openapi-spec=openapi2-run.yaml \
  --project=PROJECT_ID --backend-auth-service-account=SERVICE_ACCOUNT_EMAIL

    Esta operación puede tardar varios minutos en completarse, ya que la configuración de la API se propaga a los sistemas descendentes. La creación de una configuración de API compleja podría tardar hasta diez minutos en completarse de forma correcta.

  6. Después de crear la configuración de la API, puedes ver sus detalles mediante la ejecución de este comando: 
    gcloud api-gateway api-configs describe CONFIG_ID \
  --api=API_ID --project=PROJECT_ID

Implementa una API Gateway

Ahora puedes implementar tu API en API Gateway. Cuando implementas una API en API Gateway, también se define una URL externa que los clientes de API pueden usar para acceder a tu API.

Ejecuta el comando siguiente para implementar la configuración de la API que acabas de crear en API Gateway:

gcloud api-gateway gateways create GATEWAY_ID \
  --api=API_ID --api-config=CONFIG_ID \
  --location=GCP_REGION --project=PROJECT_ID

Donde:

  • GATEWAY_ID especifica el nombre de la puerta de enlace.
  • API_ID especifica el nombre de la API de API Gateway asociada a esta puerta de enlace.
  • CONFIG_ID especifica el nombre de la configuración de la API implementada en la puerta de enlace.

  • GCP_REGION es la región de Google Cloud para la puerta de enlace implementada.

  • PROJECT_ID especifica el nombre del proyecto de Google Cloud.

Cuando el proceso finalice con éxito, puedes usar el siguiente comando para ver los detalles de la puerta de enlace:

gcloud api-gateway gateways describe GATEWAY_ID \
  --location=GCP_REGION --project=PROJECT_ID

Observa el valor de la propiedad defaultHostname en el resultado de este comando. Esta es la parte del nombre de host de la URL de la puerta de enlace que usarás para probar tu implementación en el siguiente paso.

Cómo probar tu implementación de API

Ahora puedes enviar solicitudes a tu API mediante la URL generada cuando se implementa tu puerta de enlace.

Ingresa la siguiente URL en el navegador web, donde:

  • DEFAULT_HOSTNAME especifica la parte del nombre de host de la URL de la puerta de enlace implementada.
  • hello es la ruta de acceso especificada en tu configuración de API.
https://DEFAULT_HOSTNAME/hello

Por ejemplo: 

https://my-gateway-a12bcd345e67f89g0h.uc.gateway.dev/hello

Deberías ver tu contenedor de Cloud Run ejecutando tu app en el navegador.

¡Listo! API Gateway administra el acceso a tu servicio de backend de Cloud Run.

Realiza un seguimiento de la actividad de la API

  1. Consulta los gráficos de actividad de tu API en la página API Gateway en la consola de Google Cloud. Haz clic en tu API para ver los gráficos de actividad en la página Descripción general. Las solicitudes pueden tardar unos minutos en reflejarse en los gráficos.

  2. Consulta los registros de solicitud de tu API en la página Visor de registros. Puedes encontrar un vínculo a la página Explorador de registros en la página API Gateway en la consola de Google Cloud.

    Ir a la página API Gateway

    Una vez en la página API Gateway, haz lo siguiente:

    1. Selecciona la API que quieres ver.
    2. Haz clic en la pestaña Detalles.
    3. Haz clic en el vínculo en Registros.

Limpia

Para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos que usaste en esta guía de inicio rápido, puedes hacer lo siguiente:

Como alternativa, también puedes borrar el proyecto de Google Cloud que se usó para este instructivo.