Plug-in Endpoints Framework Gradle

Il plug-in Gradle del framework Endpoints fornisce le attività e le configurazioni da creare e connettere Endpoints Framework per i progetti App Engine. Questo plug-in fornisce il supporto lato server e lato client. Il plug-in lato server genera documenti di discovery e specifiche OpenAPI da un progetto Java di Endpoints Framework annotato e dalle librerie client. Il plug-in lato client genera quando è disponibile un documento predittivo.

Dipendenza dal plug-in

Aggiungi la dipendenza del plug-in Gradle Endpoints Framework utilizzando lo snippet seguente in build.gradle. Lo snippet seguente recupera la dipendenza da Maven Central:

classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:1.0.2'

Plug-in lato server

Aggiungi il plug-in Gradle Endpoints Framework lato server utilizzando il seguente snippet in build.gradle:

apply plugin: 'com.google.cloud.tools.endpoints-framework-server'

Imposta la configurazione lato server in build.gradle tramite la chiusura endpointsServer:

endpointsServer {
  // Endpoints Framework Plugin server-side configuration
  hostname = "${projectId}.appspot.com"
}

Attività e proprietà lato server

Le seguenti attività sono esposte solo per il lato server.

endpointsClientLibs

Questa attività genera librerie client degli endpoint in base alle classi di servizio.

Puoi utilizzare le seguenti proprietà:

Proprietà	Descrizione
serviceClasses	Elenco di classi di servizi (classi di endpoint), deducibile da "web.xml".
clientLibDir	Directory di output per le librerie client generate.
hostname	Per impostare l'URL principale per le librerie client generate. Ad esempio, utilizzando "hostname = myapp.appspot.com" produrrà un URL principale predefinito di `https://myapp.appspot.com/_ah/api`.

endpointsDiscoveryDocs

Questa attività genera documenti di rilevamento in base alle classi di servizio.

Puoi utilizzare le seguenti proprietà:

Proprietà	Descrizione
serviceClasses	Elenco delle classi di servizio (classi di endpoint), che può essere dedotto nel file "web.xml".
hostname	Per impostare l'URL principale per il documento di rilevamento generato. Ad esempio, l'utilizzo di "hostname = myapp.appspot.com" comporterà un URL principale predefinito di "https://myapp.appspot.com/_ah/api".

endpointsOpenApiDocs

Questa attività genera documenti OpenAPI in base alle classi di servizio.

Puoi utilizzare le seguenti proprietà:

Proprietà	Descrizione
serviceClasses	Elenco di classi di servizi (classi di endpoint), deducibile da "web.xml".
hostname	Per impostare l'URL principale per il documento OpenAPI generato. Ad esempio: utilizzando "hostname = myapp.appspot.com" produrrà l'URL "host" di "https://myapp.appspot.com" e "basePath" come "/_ah/api".

Plug-in lato client

Per aggiungere il plug-in Gradle Endpoints Framework lato client, utilizza quanto segue nel tuo build.gradle:

apply plugin: 'com.google.cloud.tools.endpoints-framework-client'

Imposta la configurazione lato server in build.gradle tramite la chiusura endpointsClient:

endpointsClient {
  // client-side properties
}

Proprietà lato client

Il plug-in lato client non espone attività come il plug-in lato server. L'applicazione del plug-in lato client genera le origini in base alle seguenti proprietà di configurazione.

Proprietà	Descrizione
discoveryDocs	Un elenco di documenti di discovery da utilizzare per la generazione delle origini.

Passaggi successivi

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