Cloud Endpoints Frameworks para la herramienta de línea de comandos de App Engine

En esta página se describe cómo generar una biblioteca cliente desde tu API del servidor de backend con la herramienta de línea de comandos de Endpoints Frameworks. Todas las apps para Java o Android pueden usar esta biblioteca a fin de llamar a la API.

Puedes generar conjuntos de bibliotecas cliente que les permitan a las aplicaciones acceder a tu API con la herramienta de línea de comandos de marcos de trabajo de Endpoints. Cuando generas una biblioteca cliente, la herramienta de línea de comandos de Endpoints Frameworks genera de forma automática un documento de descubrimiento que describe la superficie de tu API.

Para obtener la herramienta de línea de comandos de marcos de trabajo de Endpoints, descarga endpoints-framework-tools desde el Repositorio central de Maven. Después de extraer el contenido del archivo ZIP, encontrarás la herramienta en el directorio endpoints-framework-tools-2.2.1/bin/.

Cómo generar un conjunto de bibliotecas cliente desde una API

Puedes usar la herramienta de línea de comandos de marcos de trabajo de Endpoints para generar los siguientes tipos de conjuntos de clientes:

  • Maven: este conjunto incluye un archivo pom.xml con las dependencias de los marcos de trabajo de Endpoints y de la biblioteca cliente de la API de Google. El archivo readme.html proporciona información detallada sobre lo que necesitas agregar a tu archivo pom.xml según los diferentes tipos de aplicaciones de cliente y cómo compilar una biblioteca cliente para tu API con Maven.

  • Gradle: este conjunto incluye un archivo build.gradle con las dependencias de los marcos de trabajo de Endpoints y de la biblioteca cliente de la API de Google. El archivo readme.html proporciona información detallada sobre lo que necesitas agregar a tu archivo build.gradle según los diferentes tipos de aplicaciones cliente y cómo compilar una biblioteca cliente para tu API con Gradle.

  • Conjunto de clientes predeterminado: este conjunto contiene todas las bibliotecas de dependencias y el archivo source.jar generado, que es la biblioteca de Java que usas en tu cliente para llamar a tu API. Este conjunto le proporciona a tu cliente todas las capacidades de la biblioteca cliente de las API de Google, incluido OAuth. El archivo readme.html enumera los archivos .jar necesarios para los diferentes tipos de aplicaciones cliente y otros detalles sobre el uso de la biblioteca cliente.

Si usas la biblioteca cliente con una app para Android, te recomendamos que uses un conjunto de clientes Gradle.

Sintaxis de la línea de comandos

Antes de usar la herramienta de línea de comandos de marcos de trabajo de Endpoints, debes compilar tu proyecto de backend, ya que esta herramienta requiere objetos binarios compilados. De forma opcional, si no quieres usar la forma predeterminada (--war="./war"), puedes proporcionar la opción --war= que apunta al directorio compilado de salida de destino que contiene el directorio WEB-INF y las clases Java compiladas.

La sintaxis básica se define de la siguiente manera:

/path-to/endpoints-framework-tools-2.2.1/bin/endpoints-framework-tools \
    get-client-lib OPTIONS CLASS_NAME

Donde:

  • OPTIONS, si se proporciona, es uno o más elementos que se muestran en la Tabla de opciones.
  • CLASS_NAME es el nombre de la clase completo de tu API.

Por ejemplo:

/path-to/endpoints-framework-tools-2.2.1/bin/endpoints-framework-tools \
    get-client-lib --war=target/echo-1.0-SNAPSHOT -bs gradle com.example.echo.Echo

donde target/echo-1.0-SNAPSHOT es la ruta relativa o absoluta al directorio compilado de destino que contiene a WEB-INF y a las clases de backend compiladas.

Opciones

Puede utilizar las siguientes opciones:

Nombre de la opción Descripción Ejemplo
build-system Te permite especificar el tipo de conjunto de clientes se puede producir. Especifica gradle para un conjunto de clientes Gradle para Android, maven para un conjunto de clientes Maven o default (o puedes omitir esta opción) para un conjunto que contenga solo las bibliotecas de dependencias y el JAR fuente. --build-system=gradle
-bs gradle
war Establece la ruta al directorio compilado de destino WEB-INF que contiene appengine-web.xml y otros metadatos.
Valor predeterminado: ./war.		 --war=target/echo-1.0-SNAPSHOT
-w target/echo-1.0-SNAPSHOT
output Establece el directorio donde se escribe el resultado.
Predeterminado: el directorio desde el que se invoca a la herramienta.		 --output=/mydir
-o /mydir

Plataformas de cliente compatibles

Las siguientes plataformas son compatibles con el conjunto de clientes producido por la herramienta de línea de comandos de marcos de trabajo de Endpoints: