Le definizioni dell'API Endpoint lato server devono essere conformi a una serie di regole sintattiche. Android Studio li riconosce e convalida il codice durante la digitazione per aiutarti a evitare di commettere errori. Android Studio fornisce ispezioni e correzioni rapide specifiche per endpoint.
Convalida del codice durante la digitazione
Ad esempio, il tipo di backend predefinito App Engine Java Endpoints Module
contiene la seguente API endpoint minima con annotazioni che si trova nel tuo progetto
all'indirizzo <backend-name>/src/main/java/<package-name>/MyEndpoint.java
:
import javax.inject.Named;
@Api(name = "myApi", version = "v1",
namespace = @ApiNamespace(ownerDomain = "<package-name>",
ownerName = "<package-name>",
packagePath=""))
public class MyEndpoint {
@ApiMethod(name = "sayHi")
public MyBean sayHi(@Named("name") String name) {
MyBean response = new MyBean();
response.setData("Hi, " + name);
return response;
}
}
Nel codice, @Named
è obbligatorio per tutti i parametri di tipo non entità trasmessi ai metodi lato server. Se dimentichi di aggiungere questa annotazione quando modifichi sayHi
in questo codice, Android Studio sottolinea l'istruzione problematica durante la digitazione, come mostrato di seguito:
Correzioni rapide
Per aiutarti a evitare alcuni degli errori più comuni nello sviluppo di Cloud Endpoints, Android Studio fornisce correzioni rapide. Per visualizzare questi suggerimenti di correzione rapida, premi Alt + Invio se esegui Linux o Windows oppure ⌥ + Invio se usi un Mac. Ad esempio, qui Android Studio mostra una correzione rapida per l'annotazione @Named
mancante mostrata nell'esempio di codice precedente:
Come previsto, la scelta della prima soluzione rapida (Add @Named
) aggiunge @Named
al
parametro del metodo.