Strumento a riga di comando Cloud Endpoints Frameworks per App Engine

In questa pagina viene descritto come generare una libreria client dall'API del server di backend utilizzando lo strumento a riga di comando Endpoints Frameworks. Qualsiasi app Java o Android può utilizzare questa libreria per chiamare l'API.

Puoi generare bundle di librerie client che consentono alle applicazioni di accedere alla tua API utilizzando lo strumento a riga di comando Endpoints Frameworks. Quando generi una libreria client, lo strumento a riga di comando Endpoints Frameworks genera automaticamente un documento di rilevamento che descrive l'interfaccia della tua API.

Per ottenere lo strumento a riga di comando di Endpoints Frameworks, scarica endpoints-framework-tools da Maven Central Repository. Dopo aver estratto i contenuti del file ZIP, lo strumento si trova nella directory endpoints-framework-tools-2.2.1/bin/.

Generazione di un bundle di libreria client da un'API

Puoi utilizzare lo strumento a riga di comando di Endpoints Frameworks per generare di pacchetti di client:

  • Maven: questo bundle include un file pom.xml con le dipendenze dei framework di endpoint e della libreria client dell'API di Google. Il file readme.html fornisce informazioni dettagliate su ciò che devi aggiungere al tuo file pom.xml per diversi tipi di client e come creare una libreria client per l'API utilizzando Maven.

  • Gradle: questo bundle include un file build.gradle con Endpoints Frameworks e dipendenze della libreria client delle API di Google. Il file readme.html fornisce informazioni dettagliate su ciò che devi aggiungere al file build.gradle per diversi tipi di applicazioni client come creare una libreria client per l'API utilizzando Gradle.

  • Bundle client predefinito: questo bundle contiene tutte le librerie delle dipendenze e il file source.jar generato, ovvero la libreria Java che utilizzi al tuo client di chiamare l'API. Questo bundle fornisce al cliente tutte le le funzionalità della libreria client delle API di Google, compreso OAuth. Il file readme.html elenca i file .jar richiesti per diversi tipi di applicazioni client e altri dettagli per l'utilizzo della libreria client.

Se utilizzi la libreria client con un'app per Android, ti consigliamo di: usare un bundle di client Gradle.

Sintassi della riga di comando

Prima di utilizzare lo strumento a riga di comando Endpoints Frameworks, devi compilare il progetto di backend perché questo strumento richiede file binari compilati. Puoi facoltativamente, puoi fornire l'opzione --war= che punta all'output di destinazione della build directory contenente la directory WEB-INF e classi Java compilate, se non vuoi utilizzare l'impostazione predefinita (--war="./war").

La sintassi di base è la seguente:

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

dove:

  • OPTIONS, se specificato, è costituito da uno o più elementi mostrati nella tabella Opzioni.
  • CLASS_NAME è il nome completo della classe dell'API.

Ad esempio:

/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

dove target/echo-1.0-SNAPSHOT è il percorso relativo o assoluto la directory di build di destinazione contenente WEB-INF e le classi di backend compilate.

Opzioni

Puoi utilizzare le seguenti opzioni:

Nome opzione Descrizione Esempio
build-system Consente di specificare il tipo di bundle del client da produrre. Specifica gradle per un bundle client Gradle per Android, maven per un bundle client Maven o default (oppure ometti semplicemente questa opzione) per un bundle contenente solo le librerie delle dipendenze e il jar di origine. --build-system=gradle
-bs gradle
war Imposta il percorso della directory di destinazione della compilazione WEB-INF contenente appengine-web.xml e altri metadati.
Valore predefinito: ./war.		 --war=target/echo-1.0-SNAPSHOT
-w target/echo-1.0-SNAPSHOT
output Imposta la directory in cui viene scritto l'output.
Valore predefinito: la directory da cui viene richiamato lo strumento.		 --output=/mydir
-o /mydir

Piattaforme client supportate

Le seguenti piattaforme sono supportate nel bundle client prodotto dalla Strumento a riga di comando di Endpoints Frameworks: