Comienza a usar Cloud Endpoints para GKE con el ESPv2

En este instructivo, se muestra cómo configurar y, luego, implementar una API de muestra y el Proxy de servicio extensible V2 (ESPv2) a un clúster de Google Kubernetes Engine (GKE).

La API de REST del código de muestra se describe mediante la especificación de OpenAPI. En este instructivo, también se muestra cómo crear una clave de API y emplearla cuando envías solicitudes a la API.

Además, se usan imágenes de contenedor compiladas con anterioridad del código de muestra y el ESPv2, que se almacenan en Container Registry.

Para obtener una descripción general de Cloud Endpoints, consulta Acerca de Endpoints y la descripción de la arquitectura de Cloud Endpoints.

Objetivos

Utiliza la lista de tareas de alto nivel siguiente a medida que avanzas en el instructivo. Todas las tareas de la Parte 1 son necesarias para enviar solicitudes a la API con éxito.

Parte 1

  1. Configura un proyecto de Google Cloud. Consulta Antes de comenzar.
  2. Crea un clúster de contenedores en GKE. Consulta Cómo crear un clúster de contenedores.
  3. Instala y configura el software que se usa en el instructivo. Consulta Cómo instalar y configurar el software obligatorio.
  4. Descarga el código de muestra. Consulta Cómo descargar el código de muestra.
  5. Configura el archivo openapi.yaml, que se usa para configurar Cloud Endpoints. Consulta Cómo configurar Endpoints.
  6. Implementa la configuración de Endpoints para crear un servicio de Endpoints. Consulta Cómo implementar la configuración de Endpoints.
  7. Implementa la API y el ESP en el clúster. Consulta Cómo implementar el backend de la API.
  8. Obtén la dirección IP del clúster. Consulta Cómo obtener la dirección IP externa del clúster.
  9. Envía una solicitud a la API mediante una dirección IP. Consulta Cómo enviar una solicitud mediante la dirección IP.
  10. Realiza un seguimiento de la actividad de la API. Consulta Cómo realizar un seguimiento de la actividad de la API.

Parte 2

  1. Configura un registro DNS para la API de muestra. Consulta Cómo configurar el DNS para Endpoints.
  2. Envía una solicitud a la API con el nombre de dominio completo. Consulta Cómo enviar una solicitud mediante el FQDN.

Limpieza

Cuando hayas terminado, consulta Realizar una limpieza para evitar incurrir en cargos con tu cuenta de Google Cloud.

Costos

En este documento, usarás los siguientes componentes facturables de Google Cloud:

Para generar una estimación de costos en función del uso previsto, usa la calculadora de precios. Es posible que los usuarios nuevos de Google Cloud califiquen para obtener una prueba gratuita.

Cuando finalices las tareas que se describen en este documento, puedes borrar los recursos que creaste para evitar que continúe la facturación. Para obtener más información, consulta Cómo realizar una limpieza.

Antes de comenzar

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Make sure that billing is enabled for your Google Cloud project.

  6. Anota el ID del proyecto de Google Cloud porque lo necesitarás más tarde.

Crea un clúster de contenedores

Debes crear un clúster de contenedores en GKE para que se ejecute el código del backend de la API de muestra. El clúster necesita un alias de IP para usar el balanceo de cargas nativo del contenedor. Para crear un clúster de contenedores con un alias de IP destinado a la API de muestra:

gcloud container clusters create espv2-demo-cluster \
    --enable-ip-alias \
    --create-subnetwork="" \
    --network=default \
    --zone=us-central1-a

En el comando de ejemplo anterior, se crea un clúster, espv2-demo-cluster, con una subred aprovisionada de forma automática en la zona us-central1-a.

Toma nota del nombre y la zona del clúster, ya que los necesitarás cuando quieras autenticar kubectl al clúster del contenedor.

Instala y configura el software obligatorio

En este instructivo, instalarás la CLI de gcloud para que puedas usar Google Cloud CLI para administrar tu proyecto. Usas kubectl para ejecutar comandos en los clústeres de GKE. También necesitas una forma de probar la API.

En el procedimiento siguiente, si ya tienes el software necesario instalado, continúa con el paso próximo.

Para instalar y configurar el software necesario, completa los pasos siguientes:

  1. Necesitas una aplicación para enviar solicitudes a la API de muestra.

    • Usuarios de Linux y macOS: En este instructivo se proporciona un ejemplo del uso de curl, que suele venir preinstalado en el sistema operativo. Si no tienen curl, pueden descargarlo de la curl página de actualizaciones y descargas.
    • Usuarios de Windows: En este instructivo se proporciona un ejemplo del uso de Invoke-WebRequest, que es compatible con PowerShell 3.0 y versiones posteriores.
  2. Instala e inicializa gcloud CLI
  3. Actualiza la CLI de gcloud y, luego, instala los componentes de Endpoints: 
    gcloud components update
  4. Asegúrate de que Google Cloud CLI (gcloud) esté autorizado para acceder a tus datos y servicios en Google Cloud: 
    gcloud auth login
     En la nueva pestaña del navegador que se abre, selecciona una cuenta.
  5. Configura el proyecto predeterminado como el ID del proyecto de la manera siguiente:
    gcloud config set project YOUR_PROJECT_ID

    Reemplaza YOUR_PROJECT_ID con el ID del proyecto. Si tienes otros proyectos de Google Cloud y quieres usar gcloud para administrarlas, consulta Administra gcloud CLI parámetros de configuración.

  6. Instala kubectl: 
    gcloud components install kubectl
  7. Adquiere credenciales de usuario nuevo para usar como credenciales predeterminadas de la aplicación. Para la autorización de kubectl, se necesitan las credenciales de usuario. 
    gcloud auth application-default login
     En la nueva pestaña del navegador que se abre, selecciona una cuenta.

Descarga el código de muestra

Para que puedas ponerte en marcha rápidamente, el código de muestra se proporciona en varios lenguajes. Para descargar el código de muestra en tu máquina local, completa los pasos siguientes:

Java

Para clonar o descargar la API de muestra, sigue estos pasos:

  1. Clona el repositorio de la aplicación de muestra en tu máquina local: 
    git clone https://github.com/GoogleCloudPlatform/java-docs-samples

    Como alternativa, descarga la muestra como un archivo zip y extráelo.

  2. Ve al directorio que contiene el código de muestra:
    cd java-docs-samples/endpoints/getting-started
Python

Para clonar o descargar la API de muestra, haz lo siguiente:

  1. Clona el repositorio de la aplicación de muestra en tu máquina local: 
    git clone https://github.com/GoogleCloudPlatform/python-docs-samples

    Como alternativa, descarga la muestra como un archivo zip y extráelo.

  2. Ve al directorio que contiene el código de muestra:
    cd python-docs-samples/endpoints/getting-started
Go

Para clonar o descargar la API de muestra, haz lo siguiente:

  1. Asegúrate de que esté configurada tu variable de entorno de GOPATH.
  2. Clona el repositorio de la aplicación de muestra en tu máquina local de la siguiente forma:
    go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
  3. Ve al directorio que contiene el código de muestra:
    cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
PHP

Para clonar o descargar la API de muestra, haz lo siguiente:

  1. Clona el repositorio de la aplicación de muestra en tu máquina local: 
    git clone https://github.com/GoogleCloudPlatform/php-docs-samples

    Como alternativa, descarga la muestra como un archivo zip y extráelo.

  2. Ve al directorio que contiene el código de muestra:
    cd php-docs-samples/endpoints/getting-started
Ruby

Para clonar o descargar la API de muestra, haz lo siguiente:

  1. Clona el repositorio de la aplicación de muestra en tu máquina local: 
    git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples

    Como alternativa, descarga la muestra como un archivo zip y extráelo.

  2. Ve al directorio que contiene el código de muestra:
    cd ruby-docs-samples/endpoints/getting-started
NodeJS

Para clonar o descargar la API de muestra, haz lo siguiente:

  1. Clona el repositorio de la aplicación de muestra en tu máquina local: 
    git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples

    Como alternativa, descarga la muestra como un archivo zip y extráelo.

  2. Ve al directorio que contiene el código de muestra:
    cd nodejs-docs-samples/endpoints/getting-started

Configura Endpoints

El código de muestra incluye el archivo de configuración de OpenAPI, openapi.yaml, que está basado en OpenAPI Specification v.2.0. Para configurar Endpoints, haz lo siguiente:

  1. En el directorio de código de muestra, abre el archivo de configuración openapi.yaml.

    Java
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    Python
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    Go
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    PHP
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    Ruby
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"
    NodeJS
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

    Ten en cuenta lo siguiente:

    • En la configuración de ejemplo, se muestran las líneas cercanas al campo host, que debes modificar. Para implementar el archivo openapi.yaml en Endpoints, es necesario tener el documento completo de OpenAPI.
    • El archivo openapi.yaml de ejemplo contiene una sección para configurar una autenticación que no se necesita en este instructivo. No necesitas configurar las líneas con YOUR-SERVICE-ACCOUNT-EMAIL y YOUR-CLIENT-ID.
    • OpenAPI es una especificación independiente del lenguaje. El mismo archivo openapi.yaml se encuentra en la muestra de getting-started en cada repositorio de GitHub de cada lenguaje para mayor conveniencia.

  2. En el campo host, reemplaza el texto por el nombre del servicio de Endpoints, que debe tener el siguiente formato:
    host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"

    Reemplaza YOUR_PROJECT_ID por tu ID del proyecto de Google Cloud. Por ejemplo:

    host: "echo-api.endpoints.example-project-12345.cloud.goog"

Ten en cuenta que echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog es el nombre del servicio de Endpoints. No es el nombre de dominio calificado por completo (FQDN) que se usa para enviar solicitudes a la API.

Para obtener información sobre los campos del documento de OpenAPI que Endpoints requiere, consulta Configurar Endpoints.

Una vez que hayas completado todos los pasos de configuración de modo que puedas enviar correctamente solicitudes a la API de muestra mediante una dirección IP, consulta Cómo configurar el DNS para Endpoints si deseas obtener información sobre la configuración de echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog como el FQDN.

Implementa la configuración de Endpoints

Para implementar la configuración de Endpoints, usa el comando gcloud endpoints services deploy. Este comando usa la Administración de servicios para crear un servicio administrado.

Para implementar la configuración de Endpoints, haz lo siguiente:

  1. Asegúrate de que estés en el directorio endpoints/getting-started.
  2. Sube la configuración y crea un servicio administrado.
    gcloud endpoints services deploy openapi.yaml

Entonces, el comando gcloud llama a la API de Administración de servicios para crear un servicio administrado con el nombre que especificaste en el campo host del archivo openapi.yaml. La Administración de servicios configura el servicio de acuerdo con la configuración del archivo openapi.yaml. Cuando realizas cambios en openapi.yaml, debes volver a implementar el archivo para actualizar el servicio de Endpoints.

Mientras se crea y configura el servicio, la Administración de servicios exporta la información a la terminal. Puedes ignorar sin riesgo las advertencias que indican que las rutas de acceso en el archivo openapi.yaml no requieren una clave de API. Cuando termina de configurarse el servicio, la Administración de servicios muestra un mensaje con el ID de configuración del servicio y el nombre del servicio, de manera similar a este ejemplo:

Service Configuration [2017-02-13r0] uploaded for service [echo-api.endpoints.example-project-12345.cloud.goog]

En el ejemplo anterior, 2017-02-13r0 es el ID de configuración del servicio y echo-api.endpoints.example-project-12345.cloud.goog es el servicio de Endpoints. El ID de configuración de servicio consiste en una marca de fecha seguida de un número de revisión. Si implementas el archivo openapi.yaml otra vez el mismo día, el número de revisión aumenta en el ID de configuración del servicio. Puedes ver la configuración del servicio de Endpoints en la página Endpoints > Servicios de la consola de Google Cloud.

Si recibes un mensaje de error, consulta Cómo solucionar problemas en la implementación de la configuración de Endpoints.

Verifica los servicios requeridos

Como mínimo, Endpoints y ESP requieren que se habiliten los siguientes servicios de Google:
Name Cargo
servicemanagement.googleapis.com API de Administración de servicios
servicecontrol.googleapis.com API de Control de servicios
endpoints.googleapis.com Google Cloud Endpoints

En la mayoría de los casos, el comando de gcloud endpoints services deploy habilita estos servicios obligatorios. Sin embargo, el comando gcloud se completa de manera correcta sin habilitar los servicios requeridos en las circunstancias siguientes:

  • Usaste una aplicación de terceros, como Terraform, y no incluiste estos servicios.

  • Si implementaste la configuración de Endpoints en un proyecto existente de Google Cloud en el que se inhabilitaron explícitamente estos servicios

Usa el siguiente comando para confirmar que los servicios requeridos están habilitados:

gcloud services list

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

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

También habilita el servicio de Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

Para determinar la variable ENDPOINTS_SERVICE_NAME, puedes hacer lo siguiente:

  • Después de implementar la configuración de Endpoints, ve a la página Endpoints en la consola de Cloud. La lista de posibles ENDPOINTS_SERVICE_NAME se muestra en la columna Nombre del servicio.

  • Para OpenAPI, el ENDPOINTS_SERVICE_NAME es lo que especificaste en el campo host de tu especificación de OpenAPI. Para gRPC, el ENDPOINTS_SERVICE_NAME es lo que especificaste en el campo name de tu configuración de Endpoints de gRPC.

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

Implementa el backend de la API

Hasta ahora, implementaste el documento de OpenAPI en Service Management, pero aún no implementaste el código que entrega el backend de la API. En esta sección, aprenderás a implementar contenedores compilados con anterioridad para el ESPv2 y la API de muestra en el clúster.

Verifica los permisos necesarios

El ESP y el ESPv2 llaman a los servicios de Google que usan IAM para verificar si la identidad de llamada tiene los permisos suficientes para acceder a los recursos de IAM usados. La identidad de llamada es la cuenta de servicio conectada que implementa el ESP y el ESPv2.

Cuando se implementa en el Pod de GKE, la cuenta de servicio conectada es la cuenta de servicio de nodo. Por lo general, es la cuenta de servicio predeterminada de Compute Engine. Sigue esta recomendación de permisos para elegir una cuenta de servicio de nodo adecuada.

Si se usa Workload Identity, se puede usar una cuenta de servicio distinta de la cuenta de servicio de nodo para comunicarse con los servicios de Google. Puedes crear una cuenta de servicio de Kubernetes para que el pod ejecute el ESP y el ESPv2, una cuenta de servicio de Google y puedes asociar la cuenta de servicio de Kubernetes a la cuenta de servicio de Google.

Sigue estos pasos para asociar una cuenta de servicio de Kubernetes a una cuenta de servicio de Google. Esta cuenta de servicio de Google es la cuenta de servicio conectada.

Si la cuenta de servicio conectada es la cuenta de servicio predeterminada de Compute Engine del proyecto, y la configuración del servicio de extremo se implementa en el mismo proyecto, la cuenta de servicio debe tener los permisos suficientes para acceder a los recursos de IAM. Se puede omitir el siguiente paso de configuración de las funciones de IAM. De lo contrario, se deben agregar las siguientes funciones de IAM a la cuenta de servicio conectada.

Agrega las funciones requeridas de IAM:

En esta sección, se describen los recursos de IAM que usan el ESP y el ESPv2 y las funciones de IAM necesarias para que la cuenta de servicio conectada acceda a estos recursos.

Configuración del servicio de extremo

El ESP y el ESPv2 llaman al Control de servicios que usa la configuración del servicio de extremo. La configuración del servicio de extremo es un recurso de IAM, por lo que el ESP y el ESPv2 necesitan la función de Controlador de servicio para acceder a él.

La función de IAM se encuentra en la configuración del servicio de extremo, no en el proyecto. Un proyecto puede tener múltiples opciones de configuración de servicio de extremo.

Usa el siguiente comando de gcloud a fin de agregar la función a la cuenta de servicio conectada para la configuración del servicio de extremo.

gcloud endpoints services add-iam-policy-binding SERVICE_NAME \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/servicemanagement.serviceController

En el ejemplo anterior
* SERVICE_NAME es el nombre del servicio de extremo
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com es la cuenta de servicio conectada

Cloud Trace

El ESP y el ESPv2 llaman al servicio de Cloud Trace para exportar Trace a un proyecto. Este proyecto se llama proyecto de seguimiento. En el ESP, el proyecto de seguimiento y el proyecto que posee la configuración del servicio de extremo son los mismos. En el ESPv2, el proyecto de seguimiento se puede especificar con la marca --tracing_project_id y, de forma predeterminada, se establece el proyecto de implementación.

El ESP y el ESPv2 requieren el rol de Agente de Cloud Trace para habilitar Cloud Trace.

Usa el siguiente comando de gcloud para agregar la función a la cuenta de servicio conectada:

gcloud projects add-iam-policy-binding TRACING_PROJECT_ID \
  --member serviceAccount:SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com \
  --role roles/cloudtrace.agent

Donde
* TRACING_PROJECT_ID es el ID del proyecto de seguimiento.
* SERVICE_ACCOUNT_NAME@DEPLOY_PROJECT_ID.iam.gserviceaccount.com es la cuenta de servicio conectada. Para obtener más información, consulta ¿Qué son los roles y los permisos?

Implementa los contenedores en el clúster

Los contenedores ofrecen un mecanismo de empaquetado lógico en el que puedes abstraer aplicaciones del entorno en el que se ejecutan. Usas el procedimiento siguiente para implementar el ESPv2 y la API de muestra en el clúster. Para implementar los contenedores en el clúster, sigue estos pasos:

  1. Obtén las credenciales del clúster y haz que estén disponibles para kubectl con el comando siguiente:
        gcloud container clusters get-credentials NAME --zone ZONE
    Reemplaza NAME por el nombre del clúster y ZONE por la zona del clúster.

  2. Implementa un servicio de Kubernetes en el clúster de GKE. El servicio de Kubernetes implementa la API. git clone este repositorio, cd getting-started/ para agregar a carpeta y editar el archivo de configuración de Kubernetes LANG-deployment.yaml y reemplazar SERVICE_NAME en las opciones de inicio del ESPv2 por el nombre de tu servicio.

    Java
    - name: esp
  image: gcr.io/endpoints-release/endpoints-runtime:2
  args: [
    "--listener_port=8081",
    "--backend=127.0.0.1:8080",
    "--service=SERVICE_NAME",
    "--rollout_strategy=managed",
    "--healthz=/healthz",
  ]
  readinessProbe:
    httpGet:
      path: /healthz
      port: 8081
    Python
    - name: esp
  image: gcr.io/endpoints-release/endpoints-runtime:2
  args: [
    "--listener_port=8081",
    "--backend=http://127.0.0.1:8080",
    "--service=SERVICE_NAME",
    "--rollout_strategy=managed",
    "--healthz=/healthz",
  ]
  readinessProbe:
    httpGet:
      path: /healthz
      port: 8081
    Go
    - name: esp
  image: gcr.io/endpoints-release/endpoints-runtime:2
  args: [
    "--listener_port", "8081",
    "--backend", "127.0.0.1:8080",
    "--service", "SERVICE_NAME",
    "--rollout_strategy", "managed",
    "--healthz=/healthz",
  ]
  readinessProbe:
    httpGet:
      path: /healthz
      port: 8081
    PHP
    - name: esp
  image: gcr.io/endpoints-release/endpoints-runtime:2
  args: [
    "--listener_port", "8081",
    "--backend", "127.0.0.1:8080",
    "--service", "SERVICE_NAME",
    "--rollout_strategy", "managed",
    "--healthz=/healthz",
  ]
    Ruby
    - name: esp
  image: gcr.io/endpoints-release/endpoints-runtime:2
  args: [
    "--listener_port", "8081",
    "--backend", "127.0.0.1:8080",
    "--service", "SERVICE_NAME",
    "--rollout_strategy", "managed",
    "--healthz=/healthz",
  ]
    NodeJS
    - name: esp
  image: gcr.io/endpoints-release/endpoints-runtime:2
  args: [
    "--listener_port", "8081",
    "--backend", "127.0.0.1:8080",
    "--service", "SERVICE_NAME",
    "--rollout_strategy", "managed",
    "--healthz=/healthz",
  ]
  readinessProbe:
    httpGet:
      path: /healthz
      port: 8081

    Por ejemplo:

      args: [
    "--listener_port=8081",
    "--backend=http://127.0.0.1:8080",
    "--service=echo-api.endpoints.example-project-12345.cloud.goog ",
    "--rollout_strategy=managed",
  ]

    La opción --rollout_strategy=managed configura el ESPv2 para que use la configuración del servicio implementado más reciente. Cuando especificas esta opción, el ESPv2 detecta el cambio y comienza a aplicarlo de forma automática dentro del minuto siguiente a la implementación de una configuración de servicio nueva. Te recomendamos que especifiques esta opción en lugar de proporcionar un ID de configuración específico para que use el ESPv2. Si deseas obtener información acerca de las otras opciones del ESPv2 que se usan, consulta Opciones de inicio del ESPv2.

  3. Inicia el servicio de Kubernetes con el comando kubectl apply:

    Java
    kubectl apply -f java-deployment.yaml
    Python
    kubectl apply -f python-deployment.yaml
    Ir
    kubectl apply -f golang-deployment.yaml
    PHP
    kubectl apply -f php-deployment.yaml
    Ruby
    kubectl apply -f ruby-deployment.yaml
    NodeJS
    kubectl apply -f nodejs-deployment.yaml

Si recibes un mensaje de error, consulta Cómo solucionar problemas de Cloud Endpoints en GKE. Consulta Cómo implementar el backend de la API para obtener información adicional.

Obtén la dirección IP externa del clúster

Para enviar solicitudes a la API, necesitas la IP externa del servicio. Es posible que la dirección IP externa tarde unos minutos en estar lista después de que inicies tu servicio en el contenedor.

  1. Para ver la dirección IP externa, sigue estos pasos: kubectl get ingress
  2. Anota el valor de EXTERNAL-IP. Usas esa dirección IP cuando envías una solicitud a la API de muestra.

Envía una solicitud mediante una dirección IP

Ahora que el servicio se ejecuta en el clúster de contenedores y que tienes la dirección IP externa, puedes enviar solicitudes a la API.

Crea una clave de API y configura una variable del entorno

El código de muestra requiere una clave de API. La solicitud es más simple si configuras una variable de entorno para la clave de API.

  1. En el mismo proyecto de Google Cloud que usaste para tu API, crea una clave de API en la página de credenciales de la API. Si quieres crear una clave de API en un proyecto de Google Cloud diferente, consulta la sección sobre cómo habilitar una API en tu proyecto de Google Cloud.

    Ir a la página Credenciales

  2. Haz clic en Crear credenciales y selecciona Clave de API.
  3. Copia la clave al portapapeles.
  4. Haz clic en Cerrar.
  5. En tu computadora local, pega la clave de API para asignarla a una variable de entorno:
    • En Linux o macOS: export ENDPOINTS_KEY=AIza...
    • En Windows PowerShell, haz lo siguiente: $Env:ENDPOINTS_KEY="AIza..."

Envía la solicitud

Linux o macOS

Usa curl para enviar una solicitud HTTP con la variable de entorno ENDPOINTS_KEY que configuraste antes. Reemplaza IP_ADDRESS por la dirección IP externa de la instancia.

curl --request POST \
   --header "content-type:application/json" \
   --data '{"message":"hello world"}' \
   "http://IP_ADDRESS:80/echo?key=${ENDPOINTS_KEY}"

En el curl anterior, sucede lo siguiente:

  • La opción --data especifica los datos que se publicarán en la API.
  • La opción --header especifica que los datos están en formato JSON.

PowerShell

Usa Invoke-WebRequest para enviar una solicitud HTTP con la variable de entorno ENDPOINTS_KEY que configuraste antes. Reemplaza IP_ADDRESS por la dirección IP externa de la instancia.

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://IP_ADDRESS:80/echo?key=$Env:ENDPOINTS_KEY").Content

En el ejemplo anterior, las dos primeras líneas terminan en un acento grave. Cuando pegues el ejemplo en PowerShell, asegúrate de que no quede un espacio después de los acentos graves. Para obtener más información sobre las opciones usadas en la solicitud de ejemplo, consulta Invoke-WebRequest en la documentación de Microsoft.

App de terceros

Puedes usar una aplicación de terceros, como la extensión del navegador Chrome Postman, para enviar la solicitud:

  • Selecciona POST como el verbo HTTP.
  • Para el encabezado, selecciona la clave content-type y el valor application/json.
  • Para el cuerpo, ingresa lo siguiente:
    {"message":"hello world"}
  • En la URL, usa la clave de API real en lugar de la variable de entorno. Por ejemplo:
    http://192.0.2.0:80/echo?key=AIza...

La API repite el mensaje que le enviaste y responde lo siguiente:

{
  "message": "hello world"
}

Si no obtuviste una respuesta correcta, consulta Soluciona errores de respuesta.

¡Acabas de implementar y probar una API en Endpoints!

Cómo realizar un seguimiento de la actividad de la API

Para realizar un seguimiento de la actividad de la API, sigue estos pasos:

  1. Para ver los grafos de actividad de tu API, ve a la página Endpoints > Servicios.

    Ir a la página Servicios de Endpoints


    La solicitud puede tardar unos momentos en reflejarse en los grafos.
  2. Revisa los registros de solicitud de tu API en la página del visor de registros.

    Ir a la página Explorador de registros

Cómo configurar el DNS para Endpoints

Debido a que el nombre del servicio de Endpoints para la API se encuentra en el dominio .endpoints.YOUR_PROJECT_ID.cloud.goog, puedes usarlo como el nombre de dominio calificado por completo (FQDN) mediante un pequeño cambio de configuración en el archivo openapi.yaml. De este modo, puedes enviar solicitudes a la API de muestra si usas echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog en lugar de la dirección IP.

Para configurar DNS de Endpoints, sigue estos pasos:

  1. Abre tu archivo de configuración de OpenAPI, openapi.yaml, y agrega la propiedad x-google-endpoints en el nivel superior del archivo (sin sangría ni anidado) como se muestra en el siguiente fragmento:
    host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
  target: "IP_ADDRESS"
  2. En la propiedad name, reemplaza YOUR_PROJECT_ID por el ID del proyecto.
  3. En la propiedad target, reemplaza IP_ADDRESS por la dirección IP que usaste cuando enviaste una solicitud a la API de muestra.
  4. Implementa tu archivo de configuración de OpenAPI actualizado en la Administración de servicios:
    gcloud endpoints services deploy openapi.yaml

Por ejemplo, supongamos que el archivo openapi.yaml tiene lo siguiente configurado:

host: "echo-api.endpoints.example-project-12345.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.example-project-12345.cloud.goog"
  target: "192.0.2.1"

Cuando implementas el archivo openapi.yaml con el comando gcloud anterior, la Administración de servicios crea un registro A de DNS, echo-api.endpoints.my-project-id.cloud.goog, que se resuelve en la dirección IP de destino, 192.0.2.1. Es posible que la nueva configuración de DNS tarde algunos minutos en propagarse.

Configura SSL

Para obtener más detalles sobre cómo configurar DNS y SSL, consulta Cómo habilitar SSL para Endpoints.

Enviar una solicitud mediante el FQDN

Ahora que tienes el Registro DNS configurado para la API de muestra, envíale una solicitud mediante el FQDN (reemplaza YOUR_PROJECT_ID por el ID de tu proyecto) y la variable de entorno ENDPOINTS_KEY configurada previamente:
  • En Linux o macOS:
    curl --request POST \
    --header "content-type:application/json" \
    --data '{"message":"hello world"}' \
    "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"
  • En Windows PowerShell, haz lo siguiente:
    (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content

Crea un portal de desarrolladores para la API

Puedes usar el Portal de Cloud Endpoints a fin de crear un portal para desarrolladores, que es un sitio web en el que puedes interactuar con la API de muestra. Para obtener más información, consulta la descripción general del Portal de Cloud Endpoints.

Limpia

Para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos usados en este instructivo, borra el proyecto que contiene los recursos o conserva el proyecto y borra los recursos individuales.

Consulta Borrar una API y las instancias relacionadas para obtener información acerca de cómo detener los servicios que se usan en este instructivo.

¿Qué sigue?