Implementa y prueba una API

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

Antes de comenzar

Implementa tu API para producción

A fin de implementar una API:

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

    Reemplaza Path_to_Cloud_SDK por el resultado del comando siguiente:

     gcloud info --format="value(installation.sdk_root)"
    
  2. Ejecuta el comando siguiente en el directorio principal de la API:

     gcloud app deploy
    

    Espera unos instantes para que la implementación se realice de manera correcta; ignora los mensajes de advertencia. Cuando finaliza la implementación, aparece un mensaje similar al siguiente:

    File upload done.
    Updating service [default]...done.
    
  3. Envía una solicitud de prueba a la API como la siguiente para confirmar que la implementación es correcta:

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

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

    Los resultados son los siguientes:

    {
     "content": "echo echo"
    }
    

Si no obtuviste una respuesta correcta, consulta Cómo solucionar errores de respuesta.

Implementa varias versiones de la aplicación

Para obtener información sobre cómo realizar un control de versiones de la API y cómo implementarlas, consulta la página Administrar versiones de API.

Prueba una API localmente

Puedes usar el servidor de desarrollo local de App Engine para probar la API localmente. Si deseas obtener más información sobre el servidor de desarrollo local, consulta Usar el servidor de desarrollo local.

Para ejecutar la API localmente:

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

    dev_appserver.py YOUR_PROJECT_DIR
    
  2. Ejecuta curl para realizar una solicitud a la API como la siguiente:

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

Agrega administración de API

Endpoints Frameworks proporciona las características de administración de API siguientes:

Para que Endpoints Frameworks administre la API, debes generar y, luego, implementar un documento de OpenAPI que la describa, como se explica en la página sobre cómo agregar administración de API.