Le definizioni dell'API Endpoints lato server devono essere conformi a una serie di regole sintattiche. Android Studio li conosce e convalida il codice mentre digiti per aiutarti a evitare errori. Android Studio fornisce ispezioni e correzioni rapide specifiche per gli endpoint.
Convalida del codice durante la digitazione
Ad esempio, il tipo di backend predefinito App Engine Java Endpoints Module contiene la seguente API Endpoints annotata minima nel progetto in <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à passati ai metodi lato server. Se dimentichi di aggiungere questa annotazione quando modifichisayHi
in questo codice, Android Studio sottolineerà l'istruzione problematica mentre digiti, come mostrato di seguito:
Correzioni rapide
Per aiutarti a evitare alcuni degli errori di sviluppo di Cloud Endpoints più comuni,
Android Studio fornisce correzioni rapide. Per visualizzare questi suggerimenti per la correzione rapida, premi Alt + Invio se utilizzi Linux/Windows oppure ⌥ + Invio se utilizzi un Mac. Ad esempio, di seguito è riportato Android Studio che mostra una correzione rapida per l'annotazione @Named
mancante mostrata nell'esempio di codice precedente:
Come previsto, la scelta della prima correzione rapida (Add @Named
) aggiunge @Named
al parametro method.