En esta página, se describe cómo estructurar y anotar el código de Cloud Endpoints Frameworks. Para obtener una lista completa de todas las anotaciones compatibles, consulta Anotaciones.
Antes de comenzar
- Configura tu entorno de desarrollo.
Clona el ejemplo de esqueleto de Endpoints Frameworks:
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
El ejemplo de esqueleto de Endpoints Frameworks se ubica en:
cd appengine-java8/endpoints-v2-skeleton/
Para ayudar a explicar cómo funcionan las anotaciones, este documento usa la muestra endpoints-v2-backend
a fin de exponer las anotaciones y otros códigos que debes agregar a la muestra endpoints-v2-skeleton
para poder crearla. Al final, la muestra modificada endpoints-v2-skeleton
se debe comportar de la misma manera que la muestra endpoints-v2-backend
, que se usa en el instructivo para comenzar a usar Endpoints Frameworks en App Engine.
Crea y anota un código
Para anotar tu código:
-
Cambia los directorios al directorio fuente de Java del proyecto; por ejemplo:
src/main/java/com/example/skeleton
. -
Crea un archivo de clase JavaBean denominado
Message.java
que contiene el código siguiente: -
Edita el archivo
MyApi.java
que se encuentra en el ejemplo de esqueleto. Cambia la anotación de definición@Api
por lo siguiente:El atributo
version = "v1"
especifica la versión de la API de muestra. El valor que ingreses se vuelve parte de la ruta en la URL de tu API. Para obtener más información sobre el control de versiones, consulta Administra el control de versiones de API. -
Agrega el método
echo
como tu primer extremo de API y el método de ayudadoEcho
a tuMyApi.java
. -
Copia todas las importaciones desde
Echo.java
y pégalas en tuMyApi.java
. -
Maven
Compila el proyecto:
mvn clean package
Gradle
Compila el proyecto:
gradle clean build
Conceptos básicos de las anotaciones
Son tres las anotaciones que se suelen usar en las API de backend:
@Api
contiene los detalles de configuración de la API de backend.@ApiMethod
marca un método de clase que forma parte de la API de backend. Los métodos que no están marcados con@ApiMethod
no se incluyen cuando se generan bibliotecas cliente y documentos de descubrimiento. La anotación@ApiMethod
también se puede usar para anular la configuración de API de un método específico.@Named
se debe agregar a todos los parámetros pasados a los métodos del lado del servidor, a menos que el parámetro sea un tipo de entidad.
Para obtener una lista completa de todas las anotaciones de Endpoints Frameworks, consulta Anotaciones y sintaxis.
¿Qué sigue?
- Aprende a agregar la administración de API.
- Obtén información sobre los tipos de datos que se muestran y parámetros compatibles.
- Obtén información sobre las excepciones y los códigos de estado.