Il plug-in Gradle Endpoints Framework fornisce attività e configurazioni per compilare 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 discovery e specifiche OpenAPI da un progetto Java Endpoints Framework annotato e dalle librerie client. Il plug-in lato client genera librerie client quando è disponibile un documento di rilevamento.
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:
Plug-in lato server
Aggiungi il plug-in Gradle Endpoints Framework lato server utilizzando il seguente
snippet in build.gradle
:
Imposta la configurazione lato server in build.gradle
tramite la chiusura endpointsServer
:
Attività e proprietà lato server
Le seguenti attività sono esposte solo per il lato server.
endpointsClientLibs
Questa attività genera librerie client per gli 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, l'utilizzo di `hostname = myapp.appspot.com` avrà come risultato un URL principale predefinito di `https://myapp.appspot.com/_ah/api`. |
endpointsDiscoveryDocs
Questa attività genera documenti di rilevamento in base alle classi di servizi.
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 del documento discovery 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, l'utilizzo di "hostname = myapp.appspot.com" comporterà 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 utilizzando 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.