產生用戶端程式庫

本頁說明如何從後端 API 產生用戶端程式庫。任何 Java 或 Android 應用程式都可以使用此程式庫來呼叫 API。

如要為 API 建立 iOS 用戶端,建議您使用 REST API 適用的 Google API Objective-C 用戶端程式庫

事前準備

產生用戶端程式庫

以下操作說明示範如何使用 Cloud Endpoints Frameworks Apache MavenGradle 外掛程式,從範例 Maven 專案「開始使用 Endpoints」產生 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 程式碼時都重複執行上述步驟。

後續步驟