As definições da API Endpoints API do servidor precisam seguir uma série de regras de sintaxe. O Android Studio conhece essas regras e valida seu código conforme você digita para ajudar a evitar erros. Além disso, oferece inspeções e correções rápidas específicas para a Endpoints.
Validação de código conforme você digita
Por exemplo, o tipo de back-end Módulo de Endpoints do Java do App Engine e padrão contém a seguinte API Endpoints com anotações mínimas localizada no projeto em <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;
}
}
No código, @Named
é obrigatório para todos os parâmetros de tipos que não sejam entidade passados para os métodos no lado do servidor. Caso você esqueça de acrescentar essa anotação ao modificar sayHi
nesse código, o Android Studio sublinhará a instrução problemática conforme você digita, como mostrado abaixo:
Correções rápidas
Para ajudar você a evitar alguns dos erros de desenvolvimento mais comuns dos Cloud Endpoints, o Android Studio oferece correções rápidas. Para ver essas sugestões de correção, pressione Alt + Enter no Linux/Windows, ou ⌥ + Enter no Mac. Por exemplo, nesta imagem, o Android Studio exibe uma correção rápida para a ausência da anotação @Named
mostrada no exemplo de código acima.
Como esperado, escolher a primeira correção rápida (Add @Named
) acrescenta @Named
ao parâmetro do método.