Endpoints Framework Maven plugin

O plug-in do Maven do Framework de Endpoints fornece tarefas e configurações para criar projetos do Framework de Endpoints. Este plugin oferece suporte do lado do servidor e do lado do cliente. Os objetivos do lado do servidor geram documentos de deteção e especificações da OpenAPI a partir de um projeto Java do Framework de pontos finais anotado e de bibliotecas de cliente. O objetivo por parte do cliente gera bibliotecas de cliente quando um documento de descoberta está disponível.

Adicione o plug-in do Maven do Framework de Endpoints

Adicione o plugin do Maven do Endpoints Framework usando o seguinte fragmento do plugin ao seu 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>

Objetivos do plugin

Depois de adicionar o plug-in do Maven do Framework de Endpoints, os seguintes objetivos do Maven específicos do Framework de Endpoints estão disponíveis:

Lado do servidor

Objetivo Descrição
endpoints-framework:clientLibs Gera bibliotecas de cliente
endpoints-framework:discoveryDocs Gera documentos de descoberta
endpoints-framework:openApiDocs Gera documentos OpenAPI

Lado do cliente

Objetivo Descrição
endpoints-framework:generateSrc Gera bibliotecas de cliente a partir de documentos de descoberta.

Parâmetros de objetivos

Cada objetivo tem parâmetros associados que pode usar. Pode especificar estas definições no pom.xml ou na linha de comandos.

Para configurar estas definições no pom.xml, adicione o nome do parâmetro na secção <configuration>.

Em alternativa, para configurar estas definições na linha de comandos, siga o padrão -D[USER_PROPERTY]=[PARAMETER_VALUE].

Consulte as secções seguintes para ver uma lista dos parâmetros disponíveis para cada objetivo.

endpoints-framework:clientLibs

Este objetivo gera bibliotecas de cliente a partir do lado do servidor.

Parâmetro Descrição Propriedade do utilizador
clientLibDir Defina a localização das bibliotecas de cliente geradas. A localização predefinida é definida como `target/client-libs`. endpoints.clientLibDir
serviceClasses Parâmetro opcional para fornecer uma lista de nomes de classes de serviços (classes de pontos finais). Isto pode ser inferido a partir do `web.xml`. endpoints.serviceClasses
webappDir Indique a localização do diretório `webapp`. A localização predefinida é definida como `src/main/webapp`. endpoints.webappDir
hostname Para definir o URL raiz das bibliotecas de cliente. Por exemplo, usar `hostname = myapp.appspot.com` resulta num URL raiz predefinido de`https://myapp.appspot.com/_ah/api` endpoints.hostname

endpoints-framework:discoveryDocs

Este objetivo gera documentos de descoberta.

Parâmetro Descrição Propriedade do utilizador
discoveryDocDir Definir uma localização para os documentos de descoberta gerados. A localização predefinida é definida como `target/discovery-docs`. endpoints.discoveryDocDir
serviceClasses Parâmetro opcional para fornecer uma lista de nomes de classes de serviços (classes de pontos finais). Isto pode ser inferido a partir do `web.xml`. endpoints.serviceClasses
webappDir Indique a localização do diretório `webapp`. A localização predefinida é definida como `src/main/webapp`. endpoints.webappDir
hostname Para definir o URL raiz dos documentos de descoberta. Por exemplo, usar `hostname = myapp.appspot.com` resulta num URL raiz predefinido de`https://myapp.appspot.com/_ah/api` endpoints.hostname

endpoints-framework:openApiDocs

Este objetivo gera documentos OpenAPI.

Parâmetro Descrição Propriedade do utilizador
openApiDocDir Definir uma localização para documentos OpenAPI gerados. A localização predefinida é definida como `target/openapi-docs`. endpoints.openApiDocDir
serviceClasses Parâmetro opcional para fornecer uma lista de nomes de classes de serviços (classes de pontos finais). Isto pode ser inferido a partir do `web.xml`. endpoints.serviceClasses
webappDir Indique a localização do diretório `webapp`. A localização predefinida é definida como `src/main/webapp`. endpoints.webappDir
hostname Para definir o URL raiz para documentos OpenAPI. Por exemplo, usar `hostname = myapp.appspot.com` resulta num URL raiz predefinido de`https://myapp.appspot.com/_ah/api` endpoints.hostname

endpoints-framework:generateSrc

Este objetivo gera origens de clientes a partir de documentos de descoberta.

Parâmetro Descrição Propriedade do utilizador
discoveryDocs Defina uma lista de documentos de descoberta. endpoints.discoveryDocs
generatedSrcDir Diretório de saída para origens da biblioteca cliente geradas. A localização predefinida é em `target/generated-sources/`. endpoints.generatedSrcDir

O que se segue?

  • Explore o código do plug-in e comunique problemas no GitHub.