En esta página, se describe cómo implementar tu API.
Antes de comenzar
- Configura tu entorno de programación.
- Crea una API y anótala.
Implementa una API
Puedes implementar tu API mediante los complementos Apache Maven o Gradle de App Engine. Para implementar la API en un entorno estándar de producción de App Engine, usa el comando para el complemento:
- Usa el comando para tu complemento.
Maven
mvn appengine:deploy
Gradle
gradle appengineDeploy
- Espera a que finalice la implementación.
Envía una solicitud de prueba a la API implementada. Por ejemplo, mediante
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 que se muestra a continuación:
{ "message": "echo echo" }
Si no obtuviste una respuesta correcta, consulta Soluciona errores de respuesta.
Implementa en varias versiones de 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.
Ejecuta y prueba los backends de API de forma local
Para probar tu API de forma local, haz lo siguiente:
Compila el proyecto en el directorio raíz del proyecto. Por ejemplo:
Maven
mvn clean package
Gradle
gradle clean build
Inicia el servidor de implementación de App Engine. Por ejemplo:
Maven
mvn appengine:run
Gradle
gradle appengineRun
Realiza una solicitud a la API para probarla. Por ejemplo, con
curl
:curl \ -H "Content-Type: application/json" \ -X POST \ -d '{"message": "echo"}' \ "${HOST}/_ah/api/echo/v1/echo?n=2"
Entrega tu API desde una ruta diferente
Para entregar tu API desde una ruta diferente, en el archivo web.xml
, cambia el url-pattern
en la sección EndpointsServlet
y vuelve a implementar la API. Por ejemplo:
<servlet-mapping>
<servlet-name>EndpointsServlet</servlet-name>
<url-pattern>/example-api/*</url-pattern>
</servlet-mapping>
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.