La définition des API Endpoints côté serveur doit respecter un certain nombre de règles syntaxiques. Android Studio connaît ces règles et valide votre code au fur et à mesure de la saisie pour éviter toute erreur. Android Studio fournit des inspections et des solutions rapides spécifiques à Endpoints.
Validation du code à mesure de la saisie
Par exemple, le type de backend par défaut Module Endpoints Java pour App Engine inclut dans le répertoire <backend-name>/src/main/java/<package-name>/MyEndpoint.java
du projet l'API Endpoints annotée minimale ci-dessous :
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;
}
}
Dans le code, l'annotation @Named
est obligatoire pour tous les paramètres transmis aux méthodes côté serveur qui ne sont pas de type entité. Si vous oubliez d'ajouter cette annotation lors de la modification de sayHi
dans le code, Android Studio soulignera la déclaration problématique lors de la saisie, comme indiqué ci-dessous :
Solutions rapides
Pour vous aider à éviter les erreurs de développement les plus courantes dans Cloud Endpoints, Android Studio propose des solutions rapides. Pour faire apparaître ces suggestions, appuyez sur Alt + Entrée si vous travaillez sous Linux/Windows, ou sur ⌥ + Entrée si vous travaillez sous Mac. Par exemple, Android Studio affiche une solution rapide pour l'annotation @Named
manquante dans l'exemple de code ci-dessus :
Si l'on choisit la première solution rapide (Add @Named
), @Named
est ajouté au paramètre de la méthode, comme escompté.