Desplegar y probar una API

En esta página se describe cómo implementar tu API.

Antes de empezar

Desplegar una API en producción

Para desplegar una API, sigue estos pasos:

  1. Define la variable de entorno ENDPOINTS_GAE_SDK en la ruta de la carpeta del SDK de App Engine: Path_to_Cloud_SDK/platform/google_appengine.

    Sustituye Path_to_Cloud_SDK por el resultado del siguiente comando:

     gcloud info --format="value(installation.sdk_root)"

  2. Ejecuta el siguiente comando en el directorio principal de la API:

     gcloud app deploy

    Espera unos instantes a que la implementación se complete correctamente. Ignora los mensajes de advertencia. Cuando se complete la implementación, aparecerá un mensaje similar al siguiente:

    File upload done.
Updating service [default]...done.

  3. Para confirmar que el despliegue se ha realizado correctamente, envía una solicitud de prueba a la API. Por ejemplo:

    curl --request POST \
   --header "Content-Type: application/json" \
   --data '{"content":"echo"}' \
   https://PROJECT_ID.appspot.com/_ah/api/echo/v1/echo?n=2

    Sustituye PROJECT_ID por el ID de tu proyecto y echo por el nombre de tu API.

    Estos son los resultados:

    {
 "content": "echo echo"
}

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

Desplegar en varias versiones de la aplicación

Para obtener información sobre cómo gestionar las versiones de la API y cómo implementar versiones, consulta Gestionar versiones de APIs.

Probar una API de forma local

Puedes usar el servidor de desarrollo local de App Engine para probar tu API localmente. Para obtener más información sobre el servidor de desarrollo local, consulta el artículo Utilizar el servidor de desarrollo local.

Para ejecutar tu API de forma local, sigue estos pasos:

  1. Desde el directorio raíz del proyecto, inicia el servidor de desarrollo de App Engine:

    dev_appserver.py YOUR_PROJECT_DIR

  2. Ejecuta curl para hacer una solicitud a la API. Por ejemplo:

     curl --request POST \
    --header "Content-Type: application/json" \
    --data '{"message":"echo"}' \
    "${HOST}/_ah/api/echo/v1/echo?n=2"

Añadir gestión de APIs

Endpoints Frameworks ofrece funciones de gestión de APIs como las siguientes:

Para que Endpoints Frameworks gestione tu API, debes generar y desplegar un documento de OpenAPI que describa tu API, tal como se explica en el artículo Añadir gestión de APIs.