このページでは、バックエンド API からクライアント ライブラリを生成する方法について説明します。Java アプリまたは Android アプリでこのライブラリを使うと、API を呼び出すことができます。
API に対応する iOS クライアントを作成するには、REST API 用の Google API Objective-C クライアント ライブラリの使用をおすすめします。
始める前に
- 開発環境をセットアップします。
- API にアノテーションが正しく設定されていることを確認します。
クライアント ライブラリを生成する
次の手順では、Cloud Endpoints Frameworks の Apache Maven と Gradle プラグインを使用して、サンプル Maven プロジェクトの Endpoints スタートガイドから Gradle クライアント バンドルを生成する方法を示します。
クライアント ライブラリを生成するには:
API をビルドします。
次のような 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
解凍ユーティリティを使用してファイルを解凍するか、別の ZIP 互換のアーカイブ解除ユーティリティを使用します。
unzip ./echo-v1-java.zip
ディレクトリを変更します。
cd echo
クライアント ライブラリを作成します。
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
のようになります。クライアント ライブラリ JAR を Java または Android アプリに追加します。
API コードを変更するたびに、上記の手順を繰り返します。