Questa pagina è stata tradotta dall'API Cloud Translation.

Plug-in Maven Endpoints Framework

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

Aggiungi il plug-in Maven Endpoints Framework

Aggiungi il plug-in Maven Endpoints Framework utilizzando il seguente snippet di plug-in al tuo 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 del plug-in

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

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 parametri che puoi utilizzare. Puoi specificare queste impostazioni in 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 sezioni seguenti per un elenco dei parametri disponibili per ciascun obiettivo.

`endpoints-framework:clientLibs`

Questo obiettivo genera librerie client lato server.

Parametro	Descrizione	Proprietà utente
`clientLibDir`	Definisci la posizione delle librerie client generate. La posizione predefinita è definita come "target/client-libs".	`endpoints.clientLibDir`
`serviceClasses`	Parametro facoltativo per fornire un elenco di nomi di classi di servizi (classi di endpoint). Questo può essere dedotto da "web.xml".	`endpoints.serviceClasses`
`webappDir`	Fornisci la posizione della directory "webapp". La posizione predefinita è definita come "src/main/webapp".	`endpoints.webappDir`
`hostname`	Per impostare l'URL principale per le librerie client. Ad esempio, l'utilizzo di "hostname = myapp.appspot.com" comporterà un URL radice 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 posizione per i documenti di scoperta generati. La posizione predefinita è definita come "target/discovery-docs".	`endpoints.discoveryDocDir`
`serviceClasses`	Parametro facoltativo per fornire un elenco di nomi di classi di servizi (classi di endpoint). Questo può essere dedotto da "web.xml".	`endpoints.serviceClasses`
`webappDir`	Fornisci la posizione della directory "webapp". La posizione predefinita è definita come "src/main/webapp".	`endpoints.webappDir`
`hostname`	Per impostare l'URL principale per i documenti discovery. Ad esempio, l'utilizzo di "hostname = myapp.appspot.com" comporterà un URL radice 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 posizione per i documenti OpenAPI generati. La posizione predefinita è definita come "target/openapi-docs".	`endpoints.openApiDocDir`
`serviceClasses`	Parametro facoltativo per fornire un elenco di nomi di classi di servizi (classi di endpoint). Questo può essere dedotto da "web.xml".	`endpoints.serviceClasses`
`webappDir`	Fornisci la posizione della directory "webapp". La posizione 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" comporterà un URL radice 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 i file sorgente della libreria client generati. La posizione predefinita è "target/generated-sources/".	`endpoints.generatedSrcDir`

Passaggi successivi

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