您可以產生用戶端程式庫套裝組合,允許應用程式使用 Endpoints Frameworks 指令列工具存取您的 API。您產生用戶端程式庫時,Endpoints Frameworks 指令列工具會自動產生用來描述 API 介面的探索文件。
如要取得 Endpoints Frameworks 指令列工具,請前往 Maven Central Repository 下載 endpoints-framework-tools
。將 ZIP 檔案解壓縮之後,您就可以在 endpoints-framework-tools-2.2.1/bin/
目錄中找到這項工具。
從 API 產生用戶端程式庫套裝組合
您可以使用 Endpoints Frameworks 指令列工具來產生下列類型的用戶端套裝組合:
Maven:這個套裝組合包含一個
pom.xml
檔案,其中具有 Endpoints Frameworks 和 Google API 用戶端程式庫依附元件。readme.html
檔案針對不同類型的用戶端應用程式,詳述您必須在pom.xml
檔案中新增哪些項目,以及如何使用 Maven 為您的 API 建構用戶端程式庫。Gradle:這個套裝組合包含一個
build.gradle
檔案,其中具有 Endpoints Frameworks 和 Google API 用戶端程式庫依附元件。readme.html
檔案針對不同類型的用戶端應用程式,詳述您必須在build.gradle
檔案中新增哪些項目,以及如何使用 Gradle 為您的 API 建構用戶端程式庫。預設的用戶端套裝組合:這個套裝組合包含所有依附元件程式庫和系統產生的
source.jar
檔案,該檔案即為您在用戶端中用來呼叫 API 的 Java 程式庫。這個套裝組合可為您的用戶端提供所有 Google API 用戶端程式庫功能 (包括 OAuth)。readme.html
檔案列出了不同用戶端應用程式類型需要的.jar
檔案,以及使用用戶端程式庫的其他詳細資料。
如果您將用戶端程式庫與 Android 應用程式搭配使用,建議您使用 Gradle 用戶端套裝組合。
指令列語法
Endpoints Frameworks 指令列工具需要編譯完成的二進位檔,因此您必須先建構後端專案,才能使用這項工具。如果您不想要使用預設值 (--war="./war"
),可以視需要提供指向建構目標輸出目錄的 --war=
選項 (這個目錄包含 WEB-INF
目錄和已編譯的 Java 類別)。
基本語法如下所示:
/path-to/endpoints-framework-tools-2.2.1/bin/endpoints-framework-tools \ get-client-lib OPTIONS CLASS_NAME
其中:
OPTIONS
(如有提供) 是「選項」表格中顯示的一或多個項目。CLASS_NAME
是 API 的完整類別名稱。
例如:
/path-to/endpoints-framework-tools-2.2.1/bin/endpoints-framework-tools \
get-client-lib --war=target/echo-1.0-SNAPSHOT -bs gradle com.example.echo.Echo
其中 target/echo-1.0-SNAPSHOT
為相對或絕對路徑,連結至包含 WEB-INF
和已編譯後端類別的目標建構目錄。
選項
您可以採用下列選項:
選項名稱 | 說明 | 範例 |
---|---|---|
build-system |
讓您指定要產生的用戶端套裝組合類型。為 Android 適用的 Gradle 用戶端套裝組合指定 gradle ,為 Maven 用戶端套裝組合指定 maven ,或者針對只包含相依元件程式庫和來源 jar 的套裝組合指定 default (也可省略這個選項)。 |
--build-system=gradle -bs gradle |
war |
設定連結至包含 appengine-web.xml 及其他中繼資料的建構目標目錄 WEB-INF 的路徑。預設值: ./war 。 |
--war=target/echo-1.0-SNAPSHOT -w target/echo-1.0-SNAPSHOT |
output |
設定要將輸出內容寫入到哪個目錄。 預設值:叫用工具所在的目錄。 |
--output=/mydir -o /mydir |
支援的用戶端平台
Endpoints Frameworks 指令列工具產生的用戶端套裝組合支援下列平台:
- Java 7 以上版本:
- Android 1.6 以上版本。
- App Engine。