クライアント ライブラリの生成

このページでは、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 へのアクセスをご覧ください。