產生用戶端程式庫

本頁說明如何使用 Python 後端 API (在伺服器上執行的程式碼) 產生用戶端程式庫。任何 Java 或 Android 應用程式都能使用此程式庫呼叫 API。

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

事前準備

  • 按照開始使用 Endpoints Frameworks 一文中的說明，將 Cloud Endpoints Frameworks 程式庫和工具下載到您的應用程式目錄中。
  • 請務必使用預期的架構程式碼修飾您的 API 程式碼。

產生用戶端程式庫

以下操作說明示範如何使用 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」。