Gerar uma biblioteca de cliente

Nesta página, mostramos como gerar uma biblioteca de cliente pelo back-end da API. Qualquer app para Java ou Android pode usar essa biblioteca para chamar a API.

Para criar clientes iOS para a API, recomendamos que você use a biblioteca de cliente Objective-C das APIs do Google para APIs REST.

Antes de começar

Como gerar a biblioteca de cliente

As instruções a seguir mostram como usar os plug-ins Apache Maven e Gradle do Cloud Endpoints Frameworks para gerar um pacote de cliente do Gradle com base no projeto de amostra do Maven em Primeiros passos com o Endpoints.

Para gerar uma biblioteca de cliente:

  1. Crie sua API.

  2. Execute a ferramenta de linha de comando do Endpoints Frameworks de forma semelhante à seguinte:

    Maven

    mvn endpoints-framework:clientLibs

    Gradle

    gradle endpointsClientLibs

    Aguarde a ferramenta gerar a biblioteca. Quando terminar, uma mensagem como esta será exibida:

    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. Descompacte o arquivo usando o utilitário de descompactação ou use outro utilitário de desarquivamento compatível com ZIP:

    unzip ./echo-v1-java.zip
    
  4. Altere o diretório:

    cd echo
    
  5. Crie a biblioteca de cliente:

    Maven

    mvn clean package

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

    Gradle

    gradle build

    A saída está no diretório build/libs. O nome de arquivo 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 ao seu aplicativo Java ou Android.

  7. Repita essas etapas toda vez que você modificar o código da API.

A seguir