Esta página se ha traducido con Cloud Translation API.

Empezar a usar API Gateway y Cloud Run

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

Lista de tareas

Usa la siguiente lista de tareas mientras sigues el tutorial. Todas las tareas son necesarias para desplegar una API Gateway en tu servicio de backend de Cloud Run.

Crea o selecciona un Google Cloud proyecto.
Si no has desplegado tu propio servicio de Cloud Run, despliega un servicio de ejemplo. Consulta el paso 7 de la sección Antes de empezar.
Habilita los servicios de API Gateway necesarios.
Crea una especificación de OpenAPI que describa tu API y configura las rutas a tu servicio de backend de Cloud Run. Consulta Crear una configuración de API.
Despliega una pasarela de API con tu configuración de API. Consulta Desplegar una pasarela de API.
Monitorizar la actividad de tus servicios. Consulta Monitorizar la actividad de las APIs.
Evita que se te apliquen cargos en tu cuenta de Google Cloud . Consulta Liberar espacio.

Antes de empezar

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

Nota: Si no tienes la intención de guardar los recursos que obtendrás a lo largo de este tutorial, crea un proyecto en lugar de seleccionar uno disponible. Después de completar estos pasos, podrás eliminar el proyecto y, con él, todos los recursos asociados.
Comprueba que la facturación esté habilitada en tu proyecto.
Habilitar la facturación
Anota el ID del proyecto que quieras usar en este tutorial. En el resto de esta página, este ID de proyecto se denomina PROJECT_ID.
Descarga e instala Google Cloud CLI.
Descargar gcloud CLI
Actualiza los componentes de gcloud:
```
gcloud components update
```
Define el proyecto predeterminado. Sustituye PROJECT_ID por el Google Cloud ID de tu proyecto.
```
gcloud config set project PROJECT_ID
```
Si no has desplegado tu propio servicio de Cloud Run, sigue los pasos de la guía de inicio rápido para desplegar un contenedor de ejemplo prediseñado para seleccionar o crear un proyecto y desplegar un backend de ejemplo. Google Cloud Anota la URL de la aplicación, así como la región y el ID de proyecto en los que se han desplegado tus aplicaciones.

Habilitar los servicios necesarios

API Gateway requiere que habilites los siguientes servicios de Google:

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

Para confirmar que los servicios necesarios están habilitados, sigue estos pasos:

gcloud services list

Si no ves los servicios necesarios, 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 los servicios de gcloud.

Crear una configuración de API

Para poder usar API Gateway y gestionar el tráfico a tu backend de Cloud Run desplegado, 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 de API Gateway que elijas. Deberá añadir un campo específico de Google que contenga la URL de cada aplicación de Cloud Run para que API Gateway tenga la información que necesita para invocar una aplicación.

Crea un archivo de texto llamado openapi2-run.yaml. Por comodidad, en esta página se hace referencia a la especificación de OpenAPI con ese nombre de archivo, pero puedes darle otro nombre si lo prefieres.

Incluye cada una de tus aplicaciones en la sección paths del archivo openapi2-run.yaml, tal como se muestra en el siguiente ejemplo:

# 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

En el campo title, sustituye API_ID por el nombre de tu API y optional-string por una breve descripción de tu elección. Si tu API aún 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 al generar claves de API que conceden acceso a esta API. Consulta los requisitos de ID de API para ver las directrices de nomenclatura de las APIs.
En el campo address de la sección x-google-backend, sustituye APP_URL por la URL real de tu servicio de Cloud Run (la ruta completa de la API llamada). Por ejemplo: https://hello-abc1def2gh-uc.a.run.app.
Nota: Si tienes pensado usar etiquetas de revisión para crear versiones de tu backend de servicio de Cloud Run, debes especificar el campo jwt_audience en address de la sección x-google-backend. El valor del campo jwt_audience debe ser la URL del servicio de Cloud Run. Por ejemplo:
```
...
  x-google-backend:
      address: https://VERSION_TAG---SERVICE_HOSTNAME/PATH
      jwt_audience: https://SERVICE_HOSTNAME
...
```
Si el campo jwt_audience no está presente, la extensión x-google-backend toma de forma predeterminada el valor del campo address para la reclamación de audiencia del JWT. Esto puede provocar una reclamación de audiencia de JWT inesperada para Cloud Run si se usa la URL de la etiqueta de revisión para address y no se especifica ningún jwt_audience.
Introduce el siguiente comando, donde:
- CONFIG_ID especifica el nombre de la configuración de la API.
- API_ID especifica el nombre de tu API. Si la API aún no existe, este comando la crea.
- PROJECT_ID especifica el nombre de tu Google Cloud proyecto.
- SERVICE_ACCOUNT_EMAIL especifica la cuenta de servicio que se usa para firmar tokens de back-ends con la autenticación configurada. Para obtener más información, consulta el artículo Crear una cuenta de servicio.
  Nota: La cuenta de servicio que se utilice para crear una configuración de API para un backend de Cloud Run debe tener asignado el rol run.invoker.
```
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 posteriores. La creación de una configuración de API compleja puede tardar hasta diez minutos en completarse correctamente.
Una vez creada la configuración de la API, puede ver sus detalles ejecutando este comando:
```
gcloud api-gateway api-configs describe CONFIG_ID \
  --api=API_ID --project=PROJECT_ID
```

Desplegar una pasarela de APIs

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

Ejecuta el siguiente comando para desplegar la configuración de 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 pasarela.
API_ID especifica el nombre de la API de API Gateway asociada a esta pasarela.
CONFIG_ID especifica el nombre de la configuración de API desplegada en la pasarela.
GCP_REGION es la Google Cloud región de la pasarela implementada.
Nota:
Los valores permitidos son:
- asia-northeast1
- australia-southeast1
- europe-west1
- europe-west2
- us-east1
- us-east4
- us-central1
- us-west2
- us-west3
- us-west4
PROJECT_ID especifica el nombre de tu Google Cloud proyecto.

Cuando se haya completado correctamente, puedes usar el siguiente comando para ver los detalles de la pasarela:

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

Anota 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 pasarela que usarás para probar tu implementación en el siguiente paso.

Probar el despliegue de la API

Ahora puedes enviar solicitudes a tu API mediante la URL generada al desplegar tu pasarela.

Introduce la siguiente URL en tu navegador web:

DEFAULT_HOSTNAME especifica la parte del nombre de host de la URL de la pasarela implementada.
hello es la ruta especificada en la configuración de tu API.

https://DEFAULT_HOSTNAME/hello

Por ejemplo:

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

Deberías ver el contenedor de Cloud Run ejecutando tu aplicación en el navegador.

¡Listo! Tu gateway gestiona el acceso a tu servicio de backend de Cloud Run.

Monitorizar la actividad de la API

Consulta los gráficos de actividad de tu API en la página API Gateway de laGoogle Cloud consola. Haz clic en tu API para ver sus gráficos de actividad en la página Vista general. Las solicitudes pueden tardar unos instantes en reflejarse en los gráficos.
Consulta los registros de solicitudes de tu API en la página Explorador de registros. Puedes encontrar un enlace a la página Explorador de registros en la página API Gateway de la consolaGoogle Cloud .

Una vez que estés en la página de API Gateway:
1. Selecciona la API que quieras ver.
2. Haga clic en la pestaña Detalles.
3. Haz clic en el enlace de Registros.

Limpieza

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

También puedes eliminar el Google Cloud proyecto que has usado en este tutorial.