Scrittura e annotazione del codice

Questa pagina descrive come strutturare e annotare il codice dei framework Cloud Endpoints. Per un elenco completo di tutte le annotazione supportate, consulta Annotazioni.

Prima di iniziare

  1. Configura l'ambiente di sviluppo.

  2. Clona l'esempio di Endpoints Frameworks scheletro:

     git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git

  3. L'esempio di Endpoints Frameworks scheletro si trova in:

     cd appengine-java8/endpoints-v2-skeleton/

Per spiegare il funzionamento delle annotazioni, questo documento utilizza l'esempio endpoints-v2-backend per mostrare le annotazioni e l'altro codice che devi aggiungere all'esempio endpoints-v2-skeleton per compilarlo. Alla fine, l'esempio endpoints-v2-skeleton modificato si comporta come l'esempio endpoints-v2-backend, che viene utilizzato in Introduzione ai framework di endpoint su App Engine.

Creazione e annotazione del codice

Per annotare il codice:

  1. Cambia directory nella directory del codice sorgente Java del progetto, ad esempio: src/main/java/com/example/skeleton.
  2. Crea un file di classe JavaBean chiamato Message.java contenente il seguente codice: 
    public class Message {

  private String message;

  public String getMessage() {
    return this.message;
  }

  public void setMessage(String message) {
    this.message = message;
  }
}
  3. Modifica il file MyApi.java contenuto nell'esempio di scheletro. Modifica l'annotazione della definizione di @Api con quanto segue: 
    @Api(
    name = "echo",
    version = "v1",
    namespace =
    @ApiNamespace(
        ownerDomain = "echo.example.com",
        ownerName = "echo.example.com",
        packagePath = ""
    ),
    // ...
)

    L'attributo version = "v1" specifica la versione dell'API di esempio. Il valore inserito diventa parte del percorso nell'URL della tua API. Per ulteriori informazioni sulle versioni, consulta Gestire il controllo delle versioni dell'API.

  4. Aggiungi il seguente metodo echo come primo endpoint dell'API e il metodo di assistenza doEcho a MyApi.java. 
    @ApiMethod(name = "echo")
public Message echo(Message message, @Named("n") @Nullable Integer n) {
  return doEcho(message, n);
}
     
    private Message doEcho(Message request, Integer n) {
  Message response = new Message();
  if (n != null && n >= 0) {
    StringBuilder sb = new StringBuilder();
    for (int i = 0; i < n; i++) {
      if (i > 0) {
        sb.append(' ');
      }
      sb.append(request.getMessage());
    }
    response.setMessage(sb.toString());
  }
  return response;
}
  5. Copia tutte le importazioni da Echo.java e incollale in MyApi.java.

  6. Maven

    Compila il progetto:

    mvn clean package

    Gradle

    Compila 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 di backend.
  • @ApiMethod indica un metodo di classe che fa parte dell'API di backend. I metodi non contrassegnati con@ApiMethod non sono inclusi quando generi librerie client e documenti di rilevamento. L'annotazione @ApiMethod può essere utilizzata anche per eseguire l'override della configurazione dell'API per un metodo specifico.
  • @Named deve essere aggiunto 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 dei framework di endpoint, consulta Annotazioni e sintassi.

Passaggi successivi