Escribir y anotar el código

En esta página se describe cómo estructurar y anotar el código de Cloud Endpoints Frameworks. Para ver una lista completa de todas las anotaciones admitidas, consulta Anotaciones.

Antes de empezar

  1. Configura tu entorno de desarrollo.

  2. Clona el ejemplo de esqueleto de Endpoints Frameworks:

     git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git

  3. El ejemplo de esqueleto de Endpoints Frameworks se encuentra en:

     cd appengine-java8/endpoints-v2-skeleton/

Para explicar cómo funcionan las anotaciones, en este documento se usa el ejemplo endpoints-v2-backend para mostrar las anotaciones y otro código que debes añadir al ejemplo endpoints-v2-skeleton para que se compile. Al final, el ejemplo endpoints-v2-skeleton modificado se comporta igual que el ejemplo endpoints-v2-backend, que se usa en Empezar a usar Endpoints Frameworks en App Engine.

Crear y anotar código

Para anotar tu código, sigue estos pasos:

  1. Cambia el directorio al directorio de origen de Java del proyecto. Por ejemplo: src/main/java/com/example/skeleton.
  2. Crea un archivo de clase JavaBean llamado Message.java que contenga el siguiente código: 
    public class Message {

  private String message;

  public String getMessage() {
    return this.message;
  }

  public void setMessage(String message) {
    this.message = message;
  }
}
  3. Edita el archivo MyApi.java incluido en el ejemplo de esqueleto. Cambia la anotación de la definición de @Api por lo siguiente: 
    @Api(
    name = "echo",
    version = "v1",
    namespace =
    @ApiNamespace(
        ownerDomain = "echo.example.com",
        ownerName = "echo.example.com",
        packagePath = ""
    ),
    // ...
)

    El atributo version = "v1" especifica la versión de la API de ejemplo. El valor que introduzcas formará parte de la ruta de la URL de tu API. Para obtener más información sobre las versiones, consulta el artículo Gestionar el control de versiones de la API.

  4. Añade el siguiente método echo como tu primer endpoint de API y el método auxiliar doEcho a tu MyApi.java. 
    @ApiMethod(name = "echo")
public Message echo(Message message, @Named("n") @Nullable Integer n) {
  return doEcho(message, n);
}
     
    private Message doEcho(Message request, Integer n) {
  Message response = new Message();
  if (n != null && n >= 0) {
    StringBuilder sb = new StringBuilder();
    for (int i = 0; i < n; i++) {
      if (i > 0) {
        sb.append(' ');
      }
      sb.append(request.getMessage());
    }
    response.setMessage(sb.toString());
  }
  return response;
}
  5. Copia todas las importaciones de Echo.java y pégalas en tu MyApi.java.

  6. Maven

    Compila el proyecto:

    mvn clean package

    Gradle

    Compila el proyecto:

    gradle clean build

Conceptos básicos sobre las anotaciones

Hay tres anotaciones que se suelen usar en las APIs 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 backend. Los métodos que no están marcados con @ApiMethod no se incluyen al generar bibliotecas de cliente y documentos de descubrimiento. La anotación @ApiMethod también se puede usar para anular la configuración de la API de un método específico.
  • @Named debe añadirse a todos los parámetros que se transfieran a los métodos del lado del servidor, a menos que el parámetro sea un tipo de entidad.

Para ver una lista completa de todas las anotaciones de Endpoints Frameworks, consulta Anotaciones y sintaxis.

Siguientes pasos