生成客户端库

本页介绍如何通过 Python 后端 API(在服务器上运行的代码)生成客户端库。任何 Java 或 Android 应用都可以使用此库来调用 API。

要为您的 API 创建 iOS 客户端,我们建议您使用适用于 REST API 的 Google API Objective-C 客户端库

对于 JavaScript 应用,请参阅通过 JavaScript 发送经过身份验证的请求

准备工作

生成客户端库

以下说明演示了如何使用 Endpoints Frameworks 命令行工具通过 Cloud Endpoints 使用入门中的示例代码生成 Gradle 客户端软件包。

要生成客户端库,请执行以下操作:

  1. 将目录更改为包含 API app.yaml 文件和 API 服务类的目录。

  2. 运行 Endpoints 命令行工具,如下所示:

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

    其中 main 是包含 API 的类,EchoApi 是您的 API 名称。

    等待工具生成库;成功时,该工具会显示类似如下的消息:

        API client library written to ./echo-v1.zip
        
  3. 使用解压缩工具或其他兼容 ZIP 的取消归档工具将文件解压缩:

    unzip ./echo-v1-java.zip
        
  4. 更改目录:

    cd echo
        
  5. 构建客户端库:

    gradle build
        

    输出位于 build/libs 目录中。确切的文件名取决于客户端的版本。它类似于 echo-v1-1.23.0-SNAPSHOT.jar

  6. 将客户端库 JAR 添加到您的应用。

  7. 每次修改 API 代码时都重复执行上述步骤。

后续步骤

如需了解详情以及查看演示如何从 Python 客户端访问后端 API 的示例代码,请参阅从 Python 客户端访问后端 API