Ferramenta de linha de comando do Cloud Endpoints Frameworks para App Engine

Esta página descreve como gerar uma biblioteca de cliente a partir do seu servidor de back-end usando a ferramenta de linha de comando do Endpoints Frameworks. Qualquer aplicativo Java ou Android pode usar essa biblioteca para chamar a API.

É possível gerar pacotes de biblioteca de cliente que permitem aos aplicativos acessar a API usando a ferramenta de linha de comando do Endpoints Frameworks. Ao gerar uma biblioteca de cliente, a ferramenta de linha de comando do Endpoints Frameworks gera automaticamente um documento de descoberta que descreve a superfície da API.

Para conseguir a ferramenta de linha de comando Endpoints Frameworks, faça o download de endpoints-framework-tools no Maven Central Repository (em inglês). Depois de extrair o conteúdo do arquivo ZIP, encontre a ferramenta no diretório endpoints-framework-tools-2.2.1/bin/.

Como gerar um pacote de biblioteca de cliente com base em uma API

É possível usar a ferramenta de linha de comando do Endpoints Frameworks para gerar os seguintes tipos de pacotes do cliente:

  • Maven: esse pacote inclui um arquivo pom.xml com as dependências de biblioteca de cliente do Endpoints Frameworks e da API do Google. O arquivo readme.html contém informações detalhadas sobre o que você precisa adicionar ao arquivo pom.xml em diferentes tipos de aplicativos cliente e como criar uma biblioteca de cliente para a API usando o Maven.

  • Gradle: esse pacote inclui um arquivo build.gradle com as dependências de biblioteca de cliente do Endpoints Frameworks e da API do Google. O arquivo readme.html contém informações detalhadas sobre o que você precisa adicionar ao arquivo build.gradle em diferentes tipos de aplicativos cliente e como criar uma biblioteca de cliente para a API usando o Gradle.

  • Pacote de cliente padrão: esse pacote contém todas as bibliotecas de dependência e o arquivo source.jar gerado, que é a biblioteca Java usada no cliente para chamar a API. O pacote fornece ao cliente todos os recursos da biblioteca de cliente da API do Google, incluindo o OAuth. O arquivo readme.html lista os arquivos .jar necessários para diferentes tipos de aplicativos cliente e outros detalhes para usar a biblioteca de cliente.

Se você estiver usando a biblioteca de cliente com um app Android, recomendamos o uso de um pacote de clientes do Gradle.

Sintaxe da linha de comando

Antes de usar a ferramenta de linha de comando Endpoints Frameworks, crie seu projeto de back-end porque essa ferramenta requer binários compilados. É possível fornecer a opção --war=, que aponta para o diretório de saída de destino da criação, que contém o diretório WEB-INF e as classes java compiladas, caso não queira usar o padrão (--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

onde:

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

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

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

Opções

É possível usar as seguintes opções:

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

Plataformas de cliente com suporte

As seguintes plataformas são compatíveis no pacote do cliente produzido pela ferramenta de linha de comando do Endpoints Frameworks: