In questa pagina viene descritto come strutturare e annotare il codice di Cloud Endpoints Frameworks. Per un elenco completo di tutte le annotazioni supportate, vedi Annotazioni.
Prima di iniziare
- Configura il tuo ambiente di sviluppo.
Clona l'esempio di framework degli endpoint scheletri:
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
L'esempio di framework di endpoint scheletri si trova in:
cd appengine-java8/endpoints-v2-skeleton/
Per spiegare come funzionano le annotazioni, questo documento utilizza l'esempio endpoints-v2-backend
per mostrare le annotazioni e altri codici che devi aggiungere all'esempio endpoints-v2-skeleton
per crearlo. Alla fine, l'esempio endpoints-v2-skeleton
modificato si comporta come l'esempio endpoints-v2-backend
, che viene utilizzato nella guida introduttiva ai framework di endpoint su App Engine.
Creazione e annotazione del codice
Per annotare il codice:
-
Cambia le directory nella directory di origine Java del progetto, ad esempio:
src/main/java/com/example/skeleton
. -
Crea un file della classe JavaBean denominato
Message.java
che contenga il codice seguente: -
Modifica il file
MyApi.java
contenuto nell'esempio dello scheletro. Modifica l'annotazione di definizione di@Api
con i seguenti elementi:L'attributo
version = "v1"
specifica la versione dell'API di esempio. Il valore inserito diventa parte del percorso nell'URL alla tua API. Per ulteriori informazioni sulle versioni, consulta Gestione del controllo delle versioni dell'API. -
Aggiungi il metodo
echo
seguente come primo endpoint API e il metododoEcho
di supporto al tuoMyApi.java
. -
Copia tutte le importazioni da
Echo.java
e incollale inMyApi.java
. -
Maven
Crea il progetto:
mvn clean package
Gradle
Crea il progetto:
gradle clean build
Nozioni di base sulle annotazioni
Esistono tre annotazioni comunemente utilizzate nelle API di backend:
@Api
contiene i dettagli di configurazione dell'API backend.@ApiMethod
contrassegna un metodo della classe che fa parte dell'API di backend. I metodi che non sono contrassegnati con@ApiMethod
non vengono inclusi quando generi le librerie client e i documenti di rilevamento. L'annotazione@ApiMethod
può essere utilizzata anche per sostituire la configurazione API per un metodo specifico.- È necessario aggiungere
@Named
a tutti i parametri passati ai metodi lato server, a meno che il parametro non sia un tipo di entità.
Per un elenco completo di tutte le annotazioni di Framework di endpoint, vedi Annotazioni e sintassi.
Passaggi successivi
- Scopri come aggiungere la gestione delle API.
- Scopri di più sui parametri e sui tipi di ritorno supportati.
- Scopri di più sulle eccezioni e sui codici di stato.