Plug-in Endpoints Framework Gradle

Il plug-in Gradle di Endpoints Framework fornisce attività e configurazioni per creare e connettere Endpoints Framework per i progetti App Engine. Questo plug-in fornisce assistenza lato server e lato client. Il plug-in lato server genera documenti di rilevamento e specifiche OpenAPI da un progetto Java Endpoints Framework annotato 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 lo snippet seguente 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 Gradle di 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 entro la chiusura di 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 radice per le librerie client generate. Ad esempio, l'utilizzo di `hostname = myapp.appspot.com` genererà un URL radice 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 da `web.xml`.
hostname Per impostare l'URL radice per il documento discovery generato. Ad esempio, l'utilizzo di `hostname = myapp.appspot.com` genererà un URL radice predefinito di `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 radice 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 Gradle di Endpoints Framework lato client utilizzando quanto segue in build.gradle:

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

Imposta la configurazione lato server in build.gradle entro la chiusura di 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à origini in base alle seguenti proprietà di configurazione.

Proprietà Descrizione
discoveryDocs Un elenco di documenti di scoperta da utilizzare per generare le fonti.

Passaggi successivi

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