Endpoints Framework Maven プラグイン

Endpoints Framework Maven プラグインは、Endpoints Framework プロジェクトをビルドするタスクと構成を追加します。このプラグインは、サーバー側とクライアント側をサポートします。サーバー側のゴールは、アノテーション付きの Endpoints Framework Java プロジェクトとクライアントライブラリからディスカバリドキュメントと OpenAPI 仕様を生成します。クライアント側のゴールは、ディスカバリドキュメントが利用可能である場合にクライアントライブラリを生成します。

Endpoints Framework Maven プラグインを追加する

Endpoints Framework Maven プラグインを追加するには、次のプラグインスニペットを pom.xml に追加します。

<plugin>
  <groupId>com.google.cloud.tools</groupId>
  <artifactId>endpoints-framework-maven-plugin</artifactId>
  <version>1.0.2</version>
  <configuration>
    <!-- plugin configuration -->
    <hostname>${endpoints.project.id}.appspot.com</hostname>
  </configuration>
</plugin>

プラグインゴール

Endpoints Framework Maven プラグインを追加すると、次のような Endpoints Framework 固有の Maven ゴールを使用できます。

サーバー側

目標	説明
`endpoints-framework:clientLibs`	クライアントライブラリを生成します。
`endpoints-framework:discoveryDocs`	ディスカバリドキュメントを生成します。
`endpoints-framework:openApiDocs`	OpenAPI ドキュメントを生成します。

クライアント側

目標	説明
`endpoints-framework:generateSrc`	ディスカバリドキュメントからクライアントライブラリを生成します。

ゴールパラメータ

各ゴールには、使用できるパラメータが関連付けられています。この設定は pom.xml またはコマンドラインで指定できます。

pom.xml でこれらの設定を構成するには、<configuration> セクションにパラメータ名を追加します。

別の方法として、コマンドラインでこれらを設定するには、-D[USER_PROPERTY]=[PARAMETER_VALUE] という形式にします。

各ゴールに使用可能なパラメータのリストについては、以下のセクションをご覧ください。

`endpoints-framework:clientLibs`

このゴールは、サーバー側からクライアントライブラリを生成します。

パラメータ	説明	ユーザープロパティ
`clientLibDir`	生成されたクライアントライブラリの場所を定義します。デフォルトの場所は target/client-libs です。	`endpoints.clientLibDir`
`serviceClasses`	サービスクラス（エンドポイントクラス）名のリストを指定する省略可能なパラメータ。web.xml から推定できます。	`endpoints.serviceClasses`
`webappDir`	webapp ディレクトリの場所を指定します。デフォルトの場所は src/main/webapp です。	`endpoints.webappDir`
`hostname`	クライアントライブラリのルート URL を設定します。たとえば、hostname = myapp.appspot.com を使用すると、デフォルトのルート URL は https://myapp.appspot.com/_ah/api になります。	`endpoints.hostname`

`endpoints-framework:discoveryDocs`

このゴールは、ディスカバリドキュメントを生成します。

パラメータ	説明	ユーザープロパティ
`discoveryDocDir`	生成されたディスカバリドキュメントの場所を定義します。デフォルトの場所は target/discovery-docs です。	`endpoints.discoveryDocDir`
`serviceClasses`	サービスクラス（エンドポイントクラス）名のリストを指定する省略可能なパラメータ。web.xml から推定できます。	`endpoints.serviceClasses`
`webappDir`	webapp ディレクトリの場所を指定します。デフォルトの場所は src/main/webapp です。	`endpoints.webappDir`
`hostname`	ディスカバリドキュメントのルート URL を設定します。たとえば、hostname = myapp.appspot.com を使用すると、デフォルトのルート URL は https://myapp.appspot.com/_ah/api になります。	`endpoints.hostname`

`endpoints-framework:openApiDocs`

このゴールは、OpenAPI ドキュメントを生成します。

パラメータ	説明	ユーザープロパティ
`openApiDocDir`	生成された OpenAPI ドキュメントの場所を定義します。デフォルトの場所は target/openapi-docs です。	`endpoints.openApiDocDir`
`serviceClasses`	サービスクラス（エンドポイントクラス）名のリストを指定する省略可能なパラメータ。web.xml から推定できます。	`endpoints.serviceClasses`
`webappDir`	webapp ディレクトリの場所を指定します。デフォルトの場所は src/main/webapp です。	`endpoints.webappDir`
`hostname`	OpenAPI ドキュメントのルート URL を設定します。たとえば、hostname = myapp.appspot.com を使用すると、デフォルトのルート URL は https://myapp.appspot.com/_ah/api になります。	`endpoints.hostname`

`endpoints-framework:generateSrc`

このゴールは、ディスカバリドキュメントからクライアントソースを生成します。

パラメータ	説明	ユーザープロパティ
`discoveryDocs`	ディスカバリドキュメントのリストを定義します。	`endpoints.discoveryDocs`
`generatedSrcDir`	生成されたクライアントライブラリソースの出力ディレクトリ。デフォルトの場所は target/generated-sources/ です。	`endpoints.generatedSrcDir`

次のステップ

GitHub でプラグインのコードを調べて問題を報告します。

Endpoints Framework Maven プラグイン