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 上浏览插件代码并报告问题。