Ferramenta de linha de comandos dos frameworks do Cloud Endpoints para o App Engine

Esta página descreve como gerar uma biblioteca cliente a partir da API do servidor de back-end através da ferramenta de linha de comandos dos Frameworks de Endpoints. Qualquer app Java ou Android pode usar esta biblioteca para chamar a API.

Pode gerar pacotes de bibliotecas cliente que permitem que as aplicações acedam à sua API através da ferramenta de linha de comandos do Endpoints Frameworks. Quando gera uma biblioteca de cliente, a ferramenta de linha de comandos do Endpoints Frameworks gera automaticamente um documento Discovery que descreve a superfície da sua API.

Para obter a ferramenta de linha de comandos do Endpoints Frameworks, transfira-a endpoints-framework-tools do repositório central do Maven. Depois de extrair o conteúdo do ficheiro ZIP, a ferramenta encontra-se no diretório endpoints-framework-tools-2.2.1/bin/.

Gerar um pacote de biblioteca de cliente a partir de uma API

Pode usar a ferramenta de linha de comandos Endpoints Frameworks para gerar os seguintes tipos de pacotes de cliente:

  • Maven: este pacote inclui um ficheiro pom.xml com as dependências dos Frameworks de Endpoints e da biblioteca cliente das APIs Google. O ficheiro readme.html fornece informações detalhadas sobre o que tem de adicionar ao ficheiro pom.xml para diferentes tipos de aplicações cliente e como criar uma biblioteca cliente para a sua API através do Maven.

  • Gradle: este pacote inclui um ficheiro build.gradle com as dependências dos Frameworks de Endpoints e da biblioteca cliente das APIs Google. O ficheiro readme.html fornece informações detalhadas sobre o que tem de adicionar ao ficheiro build.gradle para diferentes tipos de aplicações cliente e como criar uma biblioteca cliente para a sua API através do Gradle.

  • Pacote de cliente predefinido: este pacote contém todas as bibliotecas de dependências e o ficheiro source.jar gerado, que é a biblioteca Java que usa no cliente para chamar a API. Este pacote fornece ao seu cliente todas as capacidades da biblioteca cliente de APIs Google, incluindo o OAuth. O ficheiro readme.html indica os ficheiros .jar necessários para diferentes tipos de aplicações cliente e outros detalhes para usar a biblioteca cliente.

Se estiver a usar a biblioteca de cliente com uma app Android, recomendamos que use um pacote de cliente do Gradle.

Sintaxe da linha de comandos

Antes de usar a ferramenta de linha de comandos do Endpoints Frameworks, tem de criar o projeto de back-end, uma vez que esta ferramenta requer ficheiros binários compilados. Opcionalmente, pode fornecer a opção --war= que aponta para o diretório de saída do destino de compilação que contém o diretório WEB-INF e as classes Java compiladas se não quiser usar o valor predefinido (--war="./war").

A sintaxe básica é a seguinte:

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

where:

  • OPTIONS, se fornecido, é um ou mais itens apresentados na tabela de opções.
  • CLASS_NAME é o nome da classe totalmente qualificado da sua API.

Por exemplo:

/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

onde target/echo-1.0-SNAPSHOT é o caminho relativo ou absoluto para o diretório de compilação de destino que contém WEB-INF e as classes de back-end compiladas.

Opções

Pode usar as seguintes opções:

Nome da opção Descrição Exemplo
build-system Permite especificar que tipo de pacote de cliente deve ser produzido. Especifique gradle para um pacote de cliente do Gradle para Android, maven para um pacote de cliente do Maven ou default (ou simplesmente omita esta opção) para um pacote que contenha apenas as bibliotecas de dependência e o JAR de origem. --build-system=gradle
-bs gradle
war Define o caminho para o diretório de destino da compilação WEB-INF que contém appengine-web.xml e outros metadados.
Predefinição: ./war.		 --war=target/echo-1.0-SNAPSHOT
-w target/echo-1.0-SNAPSHOT
output Define o diretório onde a saída é escrita.
Predefinição: o diretório a partir do qual a ferramenta é invocada.		 --output=/mydir
-o /mydir

Plataformas de cliente suportadas

As seguintes plataformas são suportadas no pacote de cliente produzido pela ferramenta de linha de comandos do Frameworks de Endpoints: