Scrittura e annotazione del codice

In questa pagina viene descritto come strutturare e annotare il codice di Cloud Endpoints Frameworks. Per un elenco completo di tutte le app supportate vedere le annotazioni Annotazioni.

Prima di iniziare

  1. Configurare l'ambiente di sviluppo.

  2. Clona lo scheletro di esempio di Endpoints Framework:

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

  3. Lo scheletro di esempio di Endpoints Frameworks si trova in:

     cd appengine-java8/endpoints-v2-skeleton/

Per spiegare come funzionano le annotazioni, questo documento utilizza il Esempio di endpoints-v2-backend per mostrare le annotazioni e l'altro codice che deve essere aggiunto all'esempio endpoints-v2-skeleton per fare in modo che venga creato. Alla fine, l'esempio endpoints-v2-skeleton modificato si comporta come endpoints-v2-backend, che viene utilizzato in Introduzione ai framework di Endpoints su App Engine.

Creazione e annotazione del codice

Per annotare il codice:

  1. Passa alla directory di origine Java del progetto, ad esempio: src/main/java/com/example/skeleton.
  2. Crea un JavaBean file di classe denominato Message.java contenente quanto segue 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 nello scheletro di esempio. 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 del campione tramite Google Cloud CLI o tramite l'API Compute Engine. Il valore inserito diventa parte del percorso nell'URL che rimanda tramite Google Cloud CLI o tramite l'API Compute Engine. Per ulteriori informazioni sulle versioni, consulta Gestione del controllo delle versioni dell'API.

  4. Aggiungi il seguente metodo echo come primo endpoint API e il metodo Metodo di supporto doEcho al tuo 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 incollali in MyApi.java.

  6. 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 backend. Metodi non sono contrassegnati con @ApiMethod non sono inclusi quando generi un client librerie e documenti di rilevamento. È possibile utilizzare anche l'annotazione @ApiMethod per eseguire l'override della configurazione API per un metodo specifico.
  • È necessario aggiungere @Named a tutti i parametri passati ai metodi lato server, a meno che il parametro è un tipo di entità.

Per un elenco completo di tutte le annotazioni di Endpoints Frameworks, vedi Annotazioni e sintassi.

Passaggi successivi