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.
- Crea o selecciona un proyecto de Google Cloud.
- Si no has implementado tu propio Cloud Run, implementa un servicio de muestra. Ve el paso 7 en Antes de comenzar.
- Habilita los servicios de API Gateway necesarios.
- Crea una especificación de OpenAPI que describa tu API y configura las rutas al servicio de backend de Cloud Run. Consulta Cómo crear una configuración de API.
- Implementa una API Gateway con tu configuración de API. Consulta Implementa una API Gateway.
- Realiza un seguimiento de la actividad de tus servicios. Consulta Cómo realizar un seguimiento de la actividad de la API.
- Evita que se generen cargos en tu cuenta de Google Cloud. Consulta Cómo realizar una limpieza.
Antes de comenzar
En Cloud Console, ve a la página Panel y selecciona o crea un proyecto de Google Cloud.
Asegúrate de tener habilitada la facturación para tu proyecto.
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.
Instala el SDK de Cloud.
Actualiza los componentes de
gcloud
:gcloud components update
Configura el proyecto predeterminado. Reemplaza PROJECT_ID por el ID del proyecto de Google Cloud
gcloud config set project PROJECT_ID
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 app, así como de la región y el ID del proyecto en los que se implementan las apps.
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 Administración de servicios |
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.comgcloud 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.
- 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. - Enumera cada una de tus apps en la sección
paths
del archivoopenapi2-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
- En el campo
title
, reemplaza 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 campotitle
se usa cuando se crean claves de API que otorgan acceso a esta API. Consulta los requisitos del ID de API para conocer los lineamientos sobre nombres de API. - En el campo
address
de la secciónx-google-backend
, reemplaza APP_URL por la URL real del servicio de Cloud Run. - Ingresa 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 del proyecto de Google Cloud.
- SERVICE_ACCOUNT_EMAIL especifica la cuenta de servicio que se creó de forma explícita para crear la configuración de la API. 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 API se propaga a los sistemas posteriores. La creación de una configuración de API compleja podría tardar hasta diez minutos en completarse de forma correcta.
- Después de crear la configuración de la API, ejecuta el siguiente comando para ver sus detalles:
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. La implementación de una API en API Gateway también 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
Ten en cuenta el valor de la propiedad defaultHostname
del resultado de este comando. Esta es la parte del nombre de host de la URL de la puerta de enlace que utilizas para probar la implementación en el siguiente paso.
Prueba la implementación de tu API
Ahora puedes enviar solicitudes a tu API mediante la URL generada durante la implementación de la puerta de enlace.
Ingresa la siguiente URL en el navegador web, donde:
- DEFAULT_HOSTNAME especifica la parte del nombre de host que contiene la URL de la puerta de enlace implementada.
hello
es la ruta de acceso 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 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.
Realice un seguimiento de la actividad de la API
Consulta los gráficos de actividad de tu API en la página API Gateway en Cloud Console. 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.
Consulta los registros de solicitud de tu API en la página Visor de registros. Se puede encontrar un vínculo a la página Explorador de registros en la página API Gateway en Cloud Console.
Una vez en la página API Gateway, haz lo siguiente:- Selecciona la API que quieres ver.
- Haz clic en la pestaña Detalles.
- Haz clic en el vínculo en Registros.
Limpia
Para evitar que se apliquen cargos a la cuenta de Google Cloud por los recursos que usaste en esta guía de inicio rápido, puedes borrar la API y las puertas de enlace. También puedes borrar el proyecto de Google Cloud que se usó para este instructivo.