生成客户端库

本页面介绍如何通过后端 API 生成客户端库。任何 Java 或 Android 应用都可以使用此库来调用 API。

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

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

准备工作

生成客户端库

以下说明演示了如何使用 Cloud Endpoints Frameworks Apache MavenGradle 插件通过 Endpoints 使用入门中的示例 Maven 项目生成 Gradle 客户端软件包。

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

  1. 构建您的 API

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

    Maven

    mvn endpoints-framework:clientLibs

    Gradle

    gradle endpointsClientLibs

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

    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. 使用解压缩工具或其他兼容 ZIP 的取消归档工具将文件解压缩:

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

    cd echo
    
  5. 构建客户端库:

    Maven

    mvn clean package

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

    Gradle

    gradle build

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

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

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

后续步骤