このページでは、Cloud Endpoints Frameworks のコードを構造化し、アノテーションを付ける方法について説明します。サポートされているすべてのアノテーションのリストについては、アノテーションをご覧ください。
始める前に
- 開発環境をセットアップします。
スケルトン Endpoints Frameworks のサンプルのクローンを作成します。
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
スケルトン Endpoints Frameworks のサンプルは次の場所にあります。
cd appengine-java8/endpoints-v2-skeleton/
アノテーションの機能の説明に役立つように、ここでは endpoints-v2-backend
サンプルを使用し、このサンプルをビルドする際に endpoints-v2-skeleton
サンプルに追加する必要があるアノテーションやその他のコードを示します。最終的に、変更された endpoints-v2-skeleton
サンプルは、App Engine での Endpoints Frameworks スタートガイドで使用されている endpoints-v2-backend
サンプルと同じように動作します。
コードの作成とアノテーションの付加
コードにアノテーションを付けるには:
-
ディレクトリをプロジェクトの Java ソース ディレクトリ(
src/main/java/com/example/skeleton
など)に変更します。 -
次のコードが含まれている
Message.java
という名前の JavaBeanクラスファイルを作成します。 -
スケルトンのサンプルに含まれている
MyApi.java
ファイルを編集します。@Api
定義のアノテーションを次のように変更します。version = "v1"
属性はサンプル API のバージョンを指定します。入力する値は、API への URL 内のパスの一部になります。バージョンの詳細については、API のバージョニングの処理をご覧ください。 -
MyApi.java
に次のecho
メソッドを最初の API エンドポイントとして追加し、さらにdoEcho
ヘルパー メソッドを追加します。 -
Echo.java
からのインポートをすべてコピーし、MyApi.java
に貼り付けます。 -
Maven
プロジェクトをビルドします。
mvn clean package
Gradle
プロジェクトをビルドします。
gradle clean build
アノテーションの基礎
バックエンドの API でよく使用される次の 3 つのアノテーションがあります。
@Api
: バックエンド API の構成の詳細を含んでいます。@ApiMethod
: バックエンド API に含まれるクラスのメソッドにマークを付けます。クライアントがライブラリとディスカバリ ドキュメントを生成するとき@ApiMethod
のマークがないメソッドは含まれません。また、特定のメソッド用の API 構成をオーバーライドするために@ApiMethod
アノテーションを使用することもできます。@Named
: サーバー側のメソッドに渡されるすべてのパラメータにこれを追加する必要があります(ただしパラメータがエンティティ タイプである場合を除く)。
Endpoints Frameworks のすべてのアノテーションの完全なリストについては、アノテーションと構文をご覧ください。