Endpoints Framework Gradle 外掛程式

Endpoints Framework Gradle 外掛程式提供了 App Engine 專案建立與連接 Endpoints Framework 所需的工作與設定。這個外掛程式也提供伺服器端及用戶端的支援服務。「伺服器端」外掛程式根據已加註的 Endpoints Framework Java 專案以及用戶端程式庫,產生 Discovery 文件和 OpenAPI 規範。「用戶端」外掛程式則在探索文件可用時,產生用戶端程式庫。

外掛程式依附元件

透過以下在 build.gradle 中的程式碼片段,新增 Endpoints Framework Gradle 外掛程式依附元件。以下程式碼片段從 Maven Central 擷取依附元件:

classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:1.0.2'

伺服器端外掛程式

使用 build.gradle 中的外掛程式片段,新增伺服器端 Endpoints Framework Gradle 外掛程式:

apply plugin: 'com.google.cloud.tools.endpoints-framework-server'

透過 endpointsServer 閉包在您的 build.gradle 中設定伺服器端設定:

endpointsServer {
  // Endpoints Framework Plugin server-side configuration
  hostname = "${projectId}.appspot.com"
}

伺服器端工作和屬性

以下的工作僅針對伺服器端公開。

endpointsClientLibs

此工作基於服務類別產生 endpoint 用戶端程式庫。

您可以使用以下屬性:

屬性 說明
serviceClasses 服務類別 (endpoints 類別) 列表,這可以從「web.xml」中推論出來。
clientLibDir 用於生成用戶端程式庫的輸出目錄。
hostname 設定生成用戶端程式庫的根網址。例如使用「hostname = myapp.appspot.com」能將預設的根網址設為「https://myapp.appspot.com/_ah/api」。

endpointsDiscoveryDocs

此工作會基於服務類別產生探索文件。

您可以使用以下屬性:

屬性 說明
serviceClasses 服務類別 (endpoints 類別) 列表,這可以從「web.xml」中推論出來。
hostname 設定生成探索文件的根網址。例如使用「hostname = myapp.appspot.com」能將預設的根網址設為「https://myapp.appspot.com/_ah/api」。

endpointsOpenApiDocs

此工作會基於服務類別產生 OpenAPI。

您可以使用以下屬性:

屬性 說明
serviceClasses 服務類別 (endpoints 類別) 列表,這可以從「web.xml」中推論出來。
hostname 設定生成 OpenAPI 文件的根網址。例如使用「hostname = myapp.appspot.com」能將主網址設為「https://myapp.appspot.com」且 basePath 為「/_ah/api」。

用戶端外掛程式

build.gradle 中使用以下的內容增加用戶端 Endpoints Framework Gradle 外掛程式:

apply plugin: 'com.google.cloud.tools.endpoints-framework-client'

透過 endpointsClient 閉包在您的 build.gradle 中設定伺服器端設定:

endpointsClient {
  // client-side properties
}

用戶端屬性

用戶端外掛程式不會公開類似於伺服器端外掛程式的工作。使用客戶端外掛程式會根據以下的設定屬性產生來源。

屬性 說明
discoveryDocs 當生成來源時,所要使用的探索文件列表。

相關資源

  • 前往 GitHub 探索外掛程式程式碼及回報問題。
本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
App Engine 適用的 Cloud Endpoints Frameworks
需要協助嗎?請前往我們的支援網頁