Empezar a usar Cloud Endpoints en el entorno flexible de App Engine con ESP

En este tutorial se muestra cómo configurar y desplegar una API de ejemplo y el Extensible Service Proxy (ESP) en una instancia del entorno flexible de App Engine. La API REST del código de ejemplo se describe mediante la especificación de OpenAPI. En el tutorial también se explica cómo crear una clave de API y usarla en las solicitudes a la API.

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

Obtener el código de ejemplo

Java

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

1. El código de muestra usa Maven. Si no tienes Maven 3.3.9 o una versión posterior, descárgalo y instálalo.
2. Clona el repositorio de aplicaciones de muestra en la máquina local:

   git clone https://github.com/GoogleCloudPlatform/java-docs-samples

   También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.

3. Accede al directorio que contiene el código de muestra:

   cd java-docs-samples/endpoints/getting-started

Python

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

1. Clona el repositorio de aplicaciones de muestra en la máquina local:

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples

   También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.

2. Accede al directorio que contiene el código de muestra:

   cd python-docs-samples/endpoints/getting-started

Ir

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

1. Asegúrate de que la variable de entorno GOPATH esté definida.
2. Clona el repositorio de aplicaciones de muestra en la máquina local:

   go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started

3. Accede 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 ejemplo, sigue estos pasos:

1. Clona el repositorio de aplicaciones de muestra en la máquina local:

   git clone https://github.com/GoogleCloudPlatform/php-docs-samples

   También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.

2. Accede al directorio que contiene el código de muestra:

   cd php-docs-samples/endpoints/getting-started

Ruby

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

1. Clona el repositorio de aplicaciones de muestra en la máquina local:

   git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples

   También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.

2. Accede al directorio que contiene el código de muestra:

   cd ruby-docs-samples/endpoints/getting-started

NodeJS

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

1. Clona el repositorio de aplicaciones de muestra en la máquina local:

   git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples

   También puedes descargar el archivo de ejemplo como archivo ZIP y extraerlo.

2. Accede al directorio que contiene el código de muestra:

   cd nodejs-docs-samples/endpoints/getting-started

Configurar Endpoints

El código de ejemplo incluye el archivo de configuración de OpenAPI, openapi-appengine.yaml, que se basa en la especificación OpenAPI v2.0.

Para configurar Endpoints, haz lo siguiente:

1. En el directorio de código de ejemplo, abre el archivo de configuración openapi-appengine.yaml.
   Java

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "YOUR-PROJECT-ID.appspot.com"

   Python

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "YOUR-PROJECT-ID.appspot.com"

   Ir

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "YOUR-PROJECT-ID.appspot.com"

   PHP

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "YOUR-PROJECT-ID.appspot.com"

   Ruby

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "YOUR-PROJECT-ID.appspot.com"

   NodeJS

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "YOUR-PROJECT-ID.appspot.com"

   Ten en cuenta lo siguiente:

   • En el ejemplo de configuración se muestran las líneas cercanas al campo host, que debe modificar. Para desplegar openapi-appengine.yaml en Endpoints, se necesita el documento OpenAPI completo.
   • El ejemplo openapi-appengine.yaml contiene una sección para configurar la autenticación que no es necesaria en este tutorial. No es necesario 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-appengine.yaml se encuentra en el ejemplo getting-started de cada repositorio de GitHub de los idiomas para mayor comodidad.

2. En la línea con el campo host, sustituye YOUR-PROJECT-ID por el ID de tu Google Cloud proyecto. Por ejemplo:

   host: "example-project-12345.appspot.com"

Endpoints usa el texto configurado en el campo host como nombre del servicio. Cuando despliegues la API en el backend de App Engine, se creará automáticamente una entrada de DNS con un nombre en el formato YOUR-PROJECT-ID.appspot.com.

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

Desplegar la configuración de Endpoints

Para desplegar la configuración de Endpoints, usa el comando gcloud endpoints services deploy. Este comando usa Gestión de servicios para crear un servicio gestionado.

Para desplegar la configuración de Endpoints, sigue estos pasos:

1. Asegúrate de que estás en el directorio endpoints/getting-started.
2. Sube la configuración y crea un servicio gestionado:

   gcloud endpoints services deploy openapi-appengine.yaml
   

El comando gcloud llama a la API Service Management para crear un servicio gestionado con el nombre que has especificado en el campo host del archivo openapi-appengine.yaml. Gestión de servicios configura el servicio según los ajustes del archivo openapi-appengine.yaml. Cuando hagas cambios en openapi-appengine.yaml, debes volver a implementar el archivo para actualizar el servicio Endpoints.

Mientras crea y configura el servicio, Gestión de servicios muestra información en la terminal. Puedes ignorar las advertencias sobre las rutas del archivo openapi-appengine.yaml que no requieren una clave de API. Cuando termine de configurar el servicio, Service Management mostrará un mensaje con el ID de configuración del servicio y el nombre del servicio, similar al siguiente:

Service Configuration [2017-02-13r0] uploaded for service [example-project-12345.appspot.com]

En el ejemplo anterior, 2017-02-13r0 es el ID de configuración del servicio y example-project-12345.appspot.com es el servicio Endpoints. El ID de configuración del servicio consta de una marca de fecha seguida de un número de revisión. Si vuelves a implementar el archivo openapi-appengine.yaml el mismo día, el número de revisión se incrementará en el ID de configuración del servicio. Puedes ver la configuración del servicio Endpoints en la página Endpoints > Services (Servicios) de la consola de Google Cloud .

Si aparece un mensaje de error, consulta Solucionar problemas de despliegue de la configuración de Endpoints.

Comprobando los servicios necesarios

Como mínimo, Endpoints y ESP requieren que los siguientes servicios de Google estén habilitados:

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

En la mayoría de los casos, el comando gcloud endpoints services deploy habilita estos servicios obligatorios. Sin embargo, el comando gcloud se completa correctamente, pero no habilita los servicios necesarios en las siguientes circunstancias:

• Si has usado una aplicación de terceros, como Terraform, y no incluyes estos servicios.

• Has desplegado la configuración de Endpoints en unGoogle Cloud proyecto en el que estos servicios se han inhabilitado explícitamente.

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

gcloud services list

Si no ves los servicios necesarios, habilítalos:

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

También debes habilitar el servicio Endpoints:

gcloud services enable ENDPOINTS_SERVICE_NAME

Para determinar el ENDPOINTS_SERVICE_NAME, puedes hacer lo siguiente:

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

• En OpenAPI, ENDPOINTS_SERVICE_NAME es el valor que has especificado en el campo host de tu especificación de OpenAPI. En gRPC, ENDPOINTS_SERVICE_NAME es el valor que has especificado en el campo name de tu configuración de endpoints de gRPC.

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

Desplegar el backend de la API

Hasta ahora, has implementado el documento OpenAPI en Service Management, pero aún no has implementado el código que sirve de backend de la API. En esta sección se explica cómo desplegar la API de ejemplo y el ESP en App Engine.

Para desplegar el backend de la API, sigue estos pasos:

1. Añade el nombre de tu servicio al archivo app.yaml:
   Java

   Abre el archivo endpoints/getting-started/src/main/appengine/app.yaml.

   endpoints_api_service:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
     name: ENDPOINTS-SERVICE-NAME
     rollout_strategy: managed

   Python

   Abre el archivo endpoints/getting-started/app.yaml.

   endpoints_api_service:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
     name: ENDPOINTS-SERVICE-NAME
     rollout_strategy: managed

   Ir

   Abre el archivo endpoints/getting-started/app.yaml.

   endpoints_api_service:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
     name: ENDPOINTS-SERVICE-NAME
     rollout_strategy: managed

   PHP

   Abre el archivo endpoints/getting-started/app.yaml.

   endpoints_api_service:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy openapi-appengine.yaml' command. If you have
     # previously run the deploy command, you can list your existing configuration
     # ids using the 'configs list' command as follows:
     #
     #     gcloud endpoints configs list --service=YOUR-PROJECT-ID.appspot.com
     #
     name: ENDPOINTS-SERVICE-NAME
     rollout_strategy: managed

   Ruby

   Abre el archivo endpoints/getting-started/app.yaml.

   endpoints_api_service:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
     name: ENDPOINTS-SERVICE-NAME
     rollout_strategy: managed

   NodeJS

   Abre el archivo endpoints/getting-started/app.yaml.

   endpoints_api_service:
     # The following values are to be replaced by information from the output of
     # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
     name: ENDPOINTS-SERVICE-NAME
     rollout_strategy: managed

   Sustituye ENDPOINTS-SERVICE-NAME por el nombre de tu servicio Endpoints. Es el mismo nombre que has configurado en el campo host de tu documento de OpenAPI. Por ejemplo:

   endpoints_api_service:
     name: example-project-12345.appspot.com
     rollout_strategy: managed

   La opción rollout_strategy: managed configura ESP para que use la última configuración de servicio implementada. Si especifica esta opción, el ESP detectará el cambio y empezará a usarlo automáticamente en un plazo de 5 minutos después de que implemente una nueva configuración de servicio. Te recomendamos que especifiques esta opción en lugar de un ID de configuración específico para que lo use ESP.

2. Guarda el archivo app.yaml.

Como la sección endpoints_api_service se incluye en el archivo app.yaml, el comando gcloud app deploy implementa y configura ESP en un contenedor independiente de tu entorno flexible de App Engine. Todo el tráfico de solicitudes se enruta a través de ESP, que proxyiza las solicitudes y las respuestas hacia y desde el contenedor que ejecuta el código del servidor backend.

3. Asegúrate de que estás en el directorio endpoints/getting-started. Aquí es donde se encuentra el archivo de configuración openapi-appengine.yaml.
4. Ejecuta el siguiente comando para desplegar la API de muestra y ESP en App Engine:
Java
Despliega con Maven:
mvn appengine:stage
gcloud app deploy target/appengine-staging
Python
gcloud app deploy
Ir
gcloud app deploy
PHP
gcloud app deploy
Ruby
gcloud app deploy
NodeJS
gcloud app deploy

El comando gcloud app deploy crea un registro DNS con el formato YOUR_PROJECT_ID.appspot.com, que se usa al enviar solicitudes a la API. Te recomendamos que esperes unos minutos antes de enviar solicitudes a tu API mientras App Engine se inicializa por completo.

Si aparece un mensaje de error, consulta Solucionar problemas de despliegue de App Engine en entornos flexibles.

Para obtener más información, consulta el artículo sobre cómo implementar el backend de la API.

Enviar solicitudes a la API

Ahora que el servicio se ejecuta en App Engine, puedes enviarle solicitudes.

Crear una clave de API y definir una variable de entorno

El código de ejemplo requiere una clave de API. Para simplificar la solicitud, puedes definir una variable de entorno para la clave de API.

1. En el mismo Google Cloud proyecto 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 otro Google Cloud proyecto, consulta el artículo sobre cómo habilitar una API en tu Google Cloud proyecto.

   Ir a la página Credenciales

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

Enviar la solicitud

Linux o macOS

1. Crea una variable de entorno para la URL de tu proyecto de App Engine. Sustituye YOUR_PROJECT_ID por elGoogle Cloud ID de tu proyecto:

   export ENDPOINTS_HOST=https://YOUR_PROJECT_ID.appspot.com

2. Envía una solicitud HTTP con las variables de entorno ENDPOINTS_HOST y ENDPOINTS_KEY que has definido anteriormente:

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

En los curl anteriores:

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

PowerShell

1. Crea una variable de entorno para la URL de tu proyecto de App Engine. Sustituye YOUR_PROJECT_ID por elGoogle Cloud ID de tu proyecto:

   $Env:ENDPOINTS_HOST="https://YOUR_PROJECT_ID.appspot.com"

2. Envía una solicitud HTTP con las variables de entorno ENDPOINTS_HOST y ENDPOINTS_KEY que has definido anteriormente:

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

En el ejemplo anterior, las dos primeras líneas terminan en una comilla inversa. Cuando pegues el ejemplo en PowerShell, asegúrate de que no haya ningún espacio después de las comillas inversas. Para obtener información sobre las opciones que se usan en la solicitud de ejemplo, consulta Invoke-WebRequest en la documentación de Microsoft.

Aplicación de terceros

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

• Selecciona POST como verbo HTTP.
• En el encabezado, selecciona la clave content-type y el valor application/json.
• En el cuerpo, introduce lo siguiente:
  {"message":"hello world"}
• En la URL, usa la appspot.comdirección y la clave de APIappspot.com reales en lugar de las variables de entorno. Por ejemplo:
  https://example-project-12345.appspot.com/echo?key=AIza...

La API devuelve el mensaje que le envías y responde con lo siguiente:

{
  "message": "hello world"
}

Si no has recibido una respuesta correcta, consulta el artículo Solucionar problemas de errores de respuesta.

Acabas de desplegar y probar una API en Endpoints.

Nota: Si quieres decirnos qué te ha gustado de este tutorial, puedes enviarnos tus comentarios en la parte inferior de esta página. Tus comentarios nos ayudan a mejorar estos tutoriales.
Si has recibido un error, únete al google-cloud-endpoints grupo de Google e infórmanos de lo que ha ido mal. Este grupo recibe respuestas de otros usuarios de Endpoints y de ingenieros de Google, que monitorizan el grupo.

Monitorizar la actividad de la API

1. Consulta los gráficos de actividad de tu API en la página Endpoints.

   Ir a la página Servicios de Endpoints

   La solicitud puede tardar unos instantes en reflejarse en los gráficos.

2. Consulta los registros de solicitudes de tu API en la página Explorador de registros.

   Ir a la página Explorador de registros