Esta página foi traduzida pela API Cloud Translation.

Plug-in Maven do Endpoints Framework

No plug-in Maven do Endpoints Framework, são fornecidas tarefas e configurações para compilar projetos do Endpoints Framework. Esse plug-in é compatível com servidor e cliente. As metas do servidor geram documentos de descoberta e especificações da OpenAPI a partir de um projeto Java anotado e de bibliotecas de clientes do Endpoints Framework. A meta do cliente gera bibliotecas de cliente quando um documento de descoberta está disponível.

Adicionar o plug-in Maven do Endpoints Framework

Adicione o plug-in do Maven do Endpoints Framework usando o seguinte snippet do plug-in em 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>

Metas do plug-in

Depois de adicionar o plug-in Maven do Endpoints Framework, as seguintes metas específicas ficam disponíveis:

Servidor

Meta	Descrição
`endpoints-framework:clientLibs`	Gera bibliotecas de clientes
`endpoints-framework:discoveryDocs`	Gera documentos de descoberta
`endpoints-framework:openApiDocs`	Gera documentos da OpenAPI

Cliente

Meta	Descrição
`endpoints-framework:generateSrc`	Gera bibliotecas de clientes a partir de documentos de descoberta.

Parâmetros de meta

Cada meta tem parâmetros associados que podem ser usados. É possível especificar essas configurações em pom.xml ou na linha de comando.

Para definir essas configurações no pom.xml, adicione o nome do parâmetro na seção <configuration>.

Como alternativa, para definir essas configurações na linha de comando, siga o padrão -D[USER_PROPERTY]=[PARAMETER_VALUE].

Consulte as seções a seguir para ver uma lista dos parâmetros disponíveis para cada meta.

`endpoints-framework:clientLibs`

Essa meta gera bibliotecas de clientes do servidor.

Parâmetro	Descrição	Propriedade do usuário
`clientLibDir`	Define a localização das bibliotecas de clientes geradas. A localização padrão é definida como "target/client-libs".	`endpoints.clientLibDir`
`serviceClasses`	Parâmetro opcional para fornecer uma Lista de nomes de classes de serviço (classes de pontos de extremidade). Isso pode ser inferido a partir do "web.xml".	`endpoints.serviceClasses`
`webappDir`	Fornece a localização do diretório "webapp". A localização padrão é definida como "src/main/webapp".	`endpoints.webappDir`
`hostname`	Define o URL raiz para as bibliotecas de cliente. Por exemplo, usar "hostname = myapp.appspot.com" gera um URL raiz padrão de "https://myapp.appspot.com/_ah/api"	`endpoints.hostname`

`endpoints-framework:discoveryDocs`

Essa meta gera documentos de descoberta.

Parâmetro	Descrição	Propriedade do usuário
`discoveryDocDir`	Define uma localização para os documentos de descoberta gerados. A localização padrão é definida como "target/discovery-docs".	`endpoints.discoveryDocDir`
`serviceClasses`	Parâmetro opcional para fornecer uma Lista de nomes de classes de serviço (classes de pontos de extremidade). Isso pode ser inferido a partir do "web.xml".	`endpoints.serviceClasses`
`webappDir`	Fornece a localização do diretório "webapp". A localização padrão é definida como "src/main/webapp".	`endpoints.webappDir`
`hostname`	Definir o URL raiz para os documentos de descoberta. Por exemplo, usar "hostname = myapp.appspot.com" gera um URL raiz padrão de "https://myapp.appspot.com/_ah/api"	`endpoints.hostname`

`endpoints-framework:openApiDocs`

Essa meta gera documentos da OpenAPI.

Parâmetro	Descrição	Propriedade do usuário
`openApiDocDir`	Define uma localização para os documentos gerados da OpenAPI. A localização padrão é definida como "target/openapi-docs".	`endpoints.openApiDocDir`
`serviceClasses`	Parâmetro opcional para fornecer uma Lista de nomes de classes de serviço (classes de pontos de extremidade). Isso pode ser inferido a partir do "web.xml".	`endpoints.serviceClasses`
`webappDir`	Fornece a localização do diretório "webapp". A localização padrão é definida como "src/main/webapp".	`endpoints.webappDir`
`hostname`	Define o URL raiz para documentos da OpenAPI. Por exemplo, usar "hostname = myapp.appspot.com" gera um URL raiz padrão de "https://myapp.appspot.com/_ah/api"	`endpoints.hostname`

`endpoints-framework:generateSrc`

Essa meta gera fontes de clientes a partir de documentos de descoberta.

Parâmetro	Descrição	Propriedade do usuário
`discoveryDocs`	Define uma lista de documentos de descoberta.	`endpoints.discoveryDocs`
`generatedSrcDir`	Diretório de saída para as fontes de biblioteca de clientes geradas. A localização padrão é "target/generated-sources/".	`endpoints.generatedSrcDir`

Próximas etapas

Confira o código do plug-in e relate problemas no GitHub.