Endpoints Framework Gradle 插件

Endpoints Framework Gradle 插件可提供用于构建和连接适用于 App Engine 的 Endpoints Framework 项目的任务和配置。此插件提供服务器端和客户端支持。服务器端插件会从带注释的 Endpoints Framework Java 项目和客户端库中生成发现文档和 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

该任务会基于服务类生成端点客户端库。

您可以使用以下属性：

属性 说明
serviceClasses 服务类别（端点类别）列表，这可以从“web.xml”推断出来。
clientLibDir 生成的客户端库的输出目录。
hostname 用于设置生成的客户端库的根网址。例如，如果使用“hostname = myapp.appspot.com”，则会导致默认根网址为“https://myapp.appspot.com/_ah/api”。

endpointsDiscoveryDocs

该任务会基于服务类别生成发现文档。

您可以使用以下属性：

属性 说明
serviceClasses 服务类别（端点类别）列表，这可以从“web.xml”推断出来。
hostname 用于设置生成的发现文档的根网址。例如，如果使用“hostname = myapp.appspot.com”，则会导致默认根网址为“https://myapp.appspot.com/_ah/api”。

endpointsOpenApiDocs

该任务会基于服务类别生成 OpenAPI 文档。

您可以使用以下属性：

属性 说明
serviceClasses 服务类别（端点类别）列表，这可以从“web.xml”推断出来。
hostname 用于设置生成的 OpenAPI 文档的根网址。例如，如果使用“hostname = myapp.appspot.com”，则会导致“host”网址为“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 上浏览插件代码并报告问题。