Plug-in Maven per framework Maven

Il plug-in Maven per Framework Maven fornisce attività e configurazioni per creare progetti framework per endpoint. Questo plug-in fornisce supporto lato server e lato client. Gli obiettivi lato server generano documenti di rilevamento e specifiche OpenAPI da un progetto Java di Endpoints Framework e dalle librerie client con annotazioni. L'obiettivo lato client genera librerie client quando è disponibile un documento di rilevamento.

Aggiungere il plug-in Maven del framework Maven

Aggiungi il plug-in Maven del framework Maven utilizzando il seguente snippet di plug-in a 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>

Obiettivi plug-in

Dopo aver aggiunto il plug-in Maven del framework Endpoints di Endpoints, sono disponibili i seguenti obiettivi Maven specifici del framework di Endpoints:

Lato server

Obiettivo	Descrizione
`endpoints-framework:clientLibs`	Genera librerie client
`endpoints-framework:discoveryDocs`	Genera documenti di rilevamento
`endpoints-framework:openApiDocs`	Genera documenti OpenAPI

Lato client

Obiettivo	Descrizione
`endpoints-framework:generateSrc`	Genera librerie client dai documenti di rilevamento.

Parametri obiettivo

A ogni obiettivo sono associati dei parametri che puoi utilizzare. Puoi specificare queste impostazioni nell'pom.xml o nella riga di comando.

Per configurare queste impostazioni in pom.xml, aggiungi il nome del parametro nella sezione <configuration>.

In alternativa, per configurare queste impostazioni nella riga di comando, segui il pattern -D[USER_PROPERTY]=[PARAMETER_VALUE].

Consulta le seguenti sezioni per un elenco dei parametri disponibili per ogni obiettivo.

`endpoints-framework:clientLibs`

Questo obiettivo genera librerie client dal lato server.

Parametro	Descrizione	Proprietà utente
`clientLibDir`	Definisci la posizione delle librerie client generate. La posizione predefinita è "target/client-libs".	`endpoints.clientLibDir`
`serviceClasses`	Parametro facoltativo per fornire un elenco di nomi delle classi di servizio (classi di endpoint). Questo può essere dedotto dal file "web.xml".	`endpoints.serviceClasses`
`webappDir`	Fornisci il percorso della directory "webapp". La località predefinita è definita come "src/main/webapp".	`endpoints.webappDir`
`hostname`	Per impostare l'URL principale delle librerie client. Ad esempio, l'utilizzo di "hostname = myapp.appspot.com" genererà un URL principale predefinito di "https://myapp.appspot.com/_ah/api"	`endpoints.hostname`

`endpoints-framework:discoveryDocs`

Questo obiettivo genera documenti di rilevamento.

Parametro	Descrizione	Proprietà utente
`discoveryDocDir`	Definisci una località per i documenti di rilevamento generati. La località predefinita è definita come "target/discovery-docs".	`endpoints.discoveryDocDir`
`serviceClasses`	Parametro facoltativo per fornire un elenco di nomi delle classi di servizio (classi di endpoint). Questo può essere dedotto dal file "web.xml".	`endpoints.serviceClasses`
`webappDir`	Fornisci il percorso della directory "webapp". La località predefinita è definita come "src/main/webapp".	`endpoints.webappDir`
`hostname`	Per impostare l'URL principale per i documenti di rilevamento. Ad esempio, l'utilizzo di "hostname = myapp.appspot.com" genererà un URL principale predefinito di "https://myapp.appspot.com/_ah/api"	`endpoints.hostname`

`endpoints-framework:openApiDocs`

Questo obiettivo genera documenti OpenAPI.

Parametro	Descrizione	Proprietà utente
`openApiDocDir`	Definisci una località per i documenti OpenAPI generati. La località predefinita è definita come "target/openapi-docs".	`endpoints.openApiDocDir`
`serviceClasses`	Parametro facoltativo per fornire un elenco di nomi delle classi di servizio (classi di endpoint). Questo può essere dedotto dal file "web.xml".	`endpoints.serviceClasses`
`webappDir`	Fornisci il percorso della directory "webapp". La località predefinita è definita come "src/main/webapp".	`endpoints.webappDir`
`hostname`	Per impostare l'URL principale per i documenti OpenAPI. Ad esempio, l'utilizzo di "hostname = myapp.appspot.com" genererà un URL principale predefinito di "https://myapp.appspot.com/_ah/api"	`endpoints.hostname`

`endpoints-framework:generateSrc`

Questo obiettivo genera origini client dai documenti di rilevamento.

Parametro	Descrizione	Proprietà utente
`discoveryDocs`	Definisci un elenco di documenti di rilevamento.	`endpoints.discoveryDocs`
`generatedSrcDir`	Directory di output per le origini della libreria client generate. La posizione predefinita è "target/generate-sources/".	`endpoints.generatedSrcDir`

Passaggi successivi

Esplora il codice plug-in e segnala eventuali problemi su GitHub.