Gerar uma biblioteca de cliente

Esta página descreve como gerar uma biblioteca cliente a partir da sua API de back-end. Qualquer app Java ou Android pode usar esta biblioteca para chamar a API.

Para criar clientes iOS para a sua API, recomendamos que use a Google APIs Objective-C Client Library for REST APIs.

Antes de começar

Gerar a biblioteca de cliente

As instruções seguintes demonstram como usar os frameworks do Cloud Endpoints Apache Maven e os plug-ins Gradle para gerar um pacote de cliente Gradle a partir do projeto Maven de exemplo Introdução aos Endpoints.

Para gerar uma biblioteca de cliente:

  1. Crie a sua API

  2. Execute a ferramenta de linha de comandos do Endpoints Frameworks de forma semelhante ao seguinte:

    Maven

    mvn endpoints-framework:clientLibs

    Gradle

    gradle endpointsClientLibs

    Aguarde que a ferramenta gere a biblioteca. Se a operação for bem-sucedida, a ferramenta apresenta uma mensagem semelhante a esta:

    Maven

    API client library written to target/client-libs/echo-v1-java.zip

    Gradle

    API client library written to build/endpointsClientLibs/echo-v1-java.zip

  3. Descomprima o ficheiro através do utilitário de descompressão ou use outro utilitário de descompressão compatível com ZIP:

    unzip ./echo-v1-java.zip

  4. Alterar diretório:

    cd echo

  5. Crie a biblioteca de cliente:

    Maven

    mvn clean package

    O resultado está no diretório target/. O nome de ficheiro exato depende da versão do cliente Java. É algo semelhante a echo-v1-1.23.0-SNAPSHOT.jar.

    Gradle

    gradle build

    O resultado está no diretório build/libs. O nome do ficheiro exato depende da versão do cliente Java. É algo semelhante a echo-v1-1.23.0-SNAPSHOT.jar.

  6. Adicione o JAR da biblioteca cliente à sua app Java ou Android.

  7. Repita estes passos sempre que modificar o código da API.

O que se segue?