Endpoints Framework Maven 外掛程式

Endpoints Framework Maven 外掛程式提供了建構 Endpoints Framework 專案所需的工作和設定。這個外掛程式也提供伺服器端及用戶端的支援服務。「伺服器端」目標根據加註的 Endpoints Framework Java 專案及用戶端程式庫，產生探索文件與 OpenAPI 規格。「用戶端」目標則在探索文件可用時，產生用戶端程式庫。

新增 Endpoints Framework Maven 外掛程式

將以下外掛程式的程式碼片段用於 pom.xml，即可新增 Endpoints Framework Maven 外掛程式：

<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 設定用戶端程式庫的根網址，例如：使用 hostname = myapp.appspot.com 能將預設根網址設為「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 設定探索文件的根網址。例如：使用 hostname = myapp.appspot.com 能將預設根網址設為「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 文件的根網址。例如：使用 hostname = myapp.appspot.com 能將預設根網址設為「https://myapp.appspot.com/_ah/api」 endpoints.hostname

endpoints-framework:generateSrc

這個目標可以從探索文件產生用戶端原始碼。

參數 說明 使用者屬性
discoveryDocs 定義探索文件的清單。 endpoints.discoveryDocs
generatedSrcDir 產生用戶端程式庫原始碼的輸出目錄，預設位置為「target/generated-sources/」。 endpoints.generatedSrcDir

後續步驟

  • 前往 GitHub 探索外掛程式程式碼及回報問題。