Desplegar y probar una API

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

Antes de empezar

Desplegar una API

Puedes desplegar tu API con los complementos Apache Maven o Gradle de App Engine. Para desplegar tu API en un entorno estándar de App Engine de producción, usa el comando de tu complemento:

  1. Usa el comando de tu complemento:

    Maven

    mvn appengine:deploy

    Gradle

    gradle appengineDeploy
  2. Espera a que finalice la implementación.

  3. Envía una solicitud de prueba a la API desplegada. Por ejemplo, si usas curl:

    curl \
    -H "Content-Type: application/json" \
    -X POST \
    -d '{"message": "echo"}' \
    "https://YOUR-PROJECT-ID.appspot.com/_ah/api/echo/v1/echo?n=2"

    Tu respuesta será similar a la siguiente:

    {
  "message": "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.

Ejecutar y probar back-ends de API de forma local

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

  1. Compila el proyecto en el directorio raíz del proyecto. Por ejemplo:

    Maven

    mvn clean package

    Gradle

    gradle clean build

  2. Inicia el servidor de desarrollo de App Engine. Por ejemplo:

    Maven

    mvn appengine:run

    Gradle

    gradle appengineRun

  3. Realiza una solicitud a la API para probarla. Por ejemplo, si usas curl:

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

Servir tu API desde una ruta diferente

Para publicar tu API desde otra ruta, en el archivo web.xml, cambia url-pattern en la sección EndpointsServlet y vuelve a implementar tu API. Por ejemplo:

<servlet-mapping>
    <servlet-name>EndpointsServlet</servlet-name>
    <url-pattern>/example-api/*</url-pattern>
</servlet-mapping>

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.