Gerar uma biblioteca de cliente

Esta página descreve como gerar uma biblioteca cliente a partir da API de back-end Python (o código que é executado no servidor). 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

  • Transfira a biblioteca e as ferramentas do Cloud Endpoints Frameworks para o diretório da sua app, conforme descrito no artigo Introdução aos Endpoints Frameworks.
  • Certifique-se de que decorou corretamente o código da API com o código das frameworks esperado.

Gerar a biblioteca de cliente

As instruções seguintes demonstram como usar a ferramenta de linha de comandos Endpoints Frameworks para gerar um pacote de cliente Gradle a partir do código de amostra de Introdução aos Cloud Endpoints.

Para gerar uma biblioteca de cliente:

  1. Mude o diretório para o diretório que contém o ficheiro app.yaml da API e as classes da API.

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

    python lib/endpoints/endpointscfg.py get_client_lib java -bs gradle main.EchoApi

    em que main é a classe que contém a sua API e EchoApi é o nome da sua API.

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

    API client library written to ./echo-v1.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:

    gradle build

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

  6. Adicione o JAR da biblioteca de cliente à sua app.

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

O que se segue?

Para ver informações e um exemplo de código que mostram como aceder a uma API de back-end a partir de um cliente Python, consulte o artigo Aceder a APIs de back-end a partir de clientes Python.