Java 用 Cloud Endpoints Frameworks について

ここでは、Java 用 Endpoints Frameworks の使用を開始する際に役立つライブラリとツールについて説明し、その他の有用な情報を示します。Endpoints Frameworks のアーキテクチャの概要については、Endpoints Frameworks についてをご覧ください。

ライブラリとツール

App Engine スタンダード環境用 Cloud Endpoints Frameworks には、次のライブラリとツールが用意されています。

  • Endpoints Frameworks は、Maven Central Repository の com.google.endpoints グループから入手できます。必要な基本 .jar ファイルは endpoints-framework アーティファクトに含まれています。詳細については、API Javadoc をご覧ください。
  • endpoints コマンドライン ツール（Linux 用）または endpoints.cmd（Windows 用）。これらを使用して、Android アプリやその他のタイプのクライアント アプリケーションから API にアクセスできるようにするための、クライアント ライブラリ バンドルとディスカバリ ドキュメントを生成できます。
  • Endpoints Frameworks Maven プラグインと Endpoints Frameworks Gradle プラグイン。これらを使用して、次のものを生成できます。
    • クライアント ライブラリ バンドルとディスカバリ ドキュメント。
    • OpenAPI 構成ファイル。このファイルは、モニタリング、ロギング、API キー検証などの API 管理機能が必要な場合に使用します。

要件

Endpoints Frameworks を使用するには、チュートリアルの手順に従ってください。

JavaScript ウェブ クライアントや、Android などのモバイル クライアントといったクライアントの開発方法を知っている必要があります。

開発プロセス

Endpoints Frameworks を使用してアプリケーションを開発するための一般的なワークフローは次のとおりです。

  1. API プロジェクトを作成し、API コードを記述します。
  2. API にアノテーションを付けます。これにより、クラスとクライアント ライブラリがここから生成されます。
  3. OpenAPI 構成ファイルを生成して、チュートリアルの手順に沿ってデプロイします。
  4. 必要に応じて、API をローカルでテストします。
  5. API をデプロイします。
  6. クライアント ライブラリを生成します。
  7. クライアント アプリケーションを作成します。このとき、API への呼び出しを行うときはクライアント ライブラリを使用します。

はじめに

まず、チュートリアルに従って、サンプル API を構成、デプロイし、API リクエストを送信する方法を確認してください。次に、このセクションに戻り、作成する API を構成、デプロイ、テストするために必要な情報を入手してください。

Endpoints バージョン 1.0 からの移行

前のバージョンの Endpoints を使用して API バックエンドをすでに開発している場合には、移行ガイドの手順に従ってアプリを Endpoints バージョン 2.0 に移行してください。