Plug-in Endpoints Framework Gradle

Il plug-in Endpoints Framework Gradle fornisce attività e configurazioni per creare e connettere Endpoints Framework per i progetti App Engine. Questo plug-in fornisce supporto lato server e lato client. Il plug-in lato server genera documenti di rilevamento e specifiche OpenAPI da un progetto Java Endpoints Framework con annotazioni e librerie client. Il plug-in lato client genera librerie client quando è disponibile un documento di rilevamento.

Dipendenza del plug-in

Aggiungi la dipendenza del plug-in Endpoints Framework Gradle utilizzando il seguente snippet in build.gradle. Il seguente snippet 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 Endpoints Framework Gradle 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 di endpoint basate sulle classi di servizio.

Puoi utilizzare le seguenti proprietà:

Proprietà Descrizione
serviceClasses Elenco delle classi di servizio (classi di endpoint), che può essere dedotto 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, l'utilizzo di `hostname = myapp.appspot.com` genererà un URL principale predefinito `https://myapp.appspot.com/_ah/api`.

endpointsDiscoveryDocs

Questa attività genera documenti di rilevamento basati sulle classi di servizio.

Puoi utilizzare le seguenti proprietà:

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

endpointsOpenApiDocs

Questa attività genera documenti OpenAPI basati sulle classi di servizio.

Puoi utilizzare le seguenti proprietà:

Proprietà Descrizione
serviceClasses Elenco delle classi di servizio (classi di endpoint), che può essere dedotto da `web.xml`.
hostname Per impostare l'URL principale per il documento OpenAPI generato. Ad esempio l'utilizzo di `hostname = myapp.appspot.com` genererà l'URL `host` di `https://myapp.appspot.com` e `basePath` come `/_ah/api`.

Plug-in lato client

Per aggiungere il plug-in Endpoints Framework Gradle lato client, utilizza quanto segue in 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 genererà le origini in base alle seguenti proprietà di configurazione.

Proprietà Descrizione
discoveryDocs Un elenco di documenti di rilevamento da utilizzare durante la generazione delle origini.

Passaggi successivi

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