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 annotazioni supportate, consulta la sezione Annotazioni.

Prima di iniziare

  1. Configura il tuo ambiente di sviluppo.
  2. Clona l'esempio di framework scheletri:

     git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
    
  3. L'esempio di framework di endpoint scheletro si trova in:

     cd appengine-java8/endpoints-v2-skeleton/
    

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

Creazione e annotazione del codice

Per annotare il tuo codice:

  1. Modifica le directory nella directory Java del progetto, ad esempio: src/main/java/com/example/skeleton.
  2. Crea un file JavaBean denominato 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 dello scheletro. Modifica l'annotazione per la definizione @Api con il seguente:
    @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 la pagina relativa alla gestione del controllo delle versioni dell'API.

  4. Aggiungi il seguente metodo echo come primo endpoint API e il metodo helper 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

    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 della configurazione dell'API backend.
  • @ApiMethod contrassegna un metodo di classe che fa parte dell'API di backend. I metodi che non sono contrassegnati con @ApiMethod non sono inclusi quando generi librerie client e documenti di rilevamento. L'annotazione @ApiMethod può essere utilizzata anche per sostituire la configurazione dell'API per un metodo specifico.
  • Il parametro @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 Framework di endpoint, consulta la sezione Annotazioni e sintassi.

Passaggi successivi