Le definizioni dell'API lato server devono essere conformi a una serie di regole sintattiche. Android Studio li riconosce e convalida il codice mentre lo digiti per aiutarti a evitare errori. Android Studio offre controlli specifici degli endpoint e correzioni rapide.
Convalida del codice durante la digitazione
Ad esempio, il tipo di backend predefinito App Engine Endpoints Module di App Engine contiene la seguente API con annotazioni minime riportata 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 sottolineerà l'affermazione problematica
durante la digitazione, come mostrato di seguito:
Correzioni veloci
Per aiutarti a evitare alcuni degli errori di sviluppo più comuni di Cloud Endpoints, Android Studio offre correzioni rapide. Per visualizzare questi suggerimenti di risoluzione rapida, premi Alt + Invio se esegui Linux/Windows o ⌥ + Invio se esegui Mac. Ad esempio, qui è riportato Android Studio che mostra una correzione rapida per l'annotazione @Named
mancante nell'esempio di codice riportato sopra:
Come previsto, la prima correzione rapida (Add @Named
) aggiunge @Named
al
parametro del metodo.