サーバー側の Endpoints API 定義は、多くの構文ルールに従っている必要があります。Android Studio はこれらのルールを把握しており、コードの入力と同時に検証を行うので、誤りを防ぐことができます。Android Studio には Endpoints 固有の検査とクイック フィックスが用意されています。
入力中のコード検証
たとえば、デフォルトのバックエンド タイプである App Engine Java Endpoints Module では、プロジェクトの <backend-name>/src/main/java/<package-name>/MyEndpoint.java
の中に次のような最小限のアノテーションが付いた Endpoints API があります。
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;
}
}
このコードの @Named
は、サーバー側のメソッドに渡される非エンティティ型のパラメータすべてに必要です。このコードの sayHi
を変更するときに、このアノテーションを追加するのを忘れた場合、Android Studio は、次のように入力時に問題のあるステートメントに下線を付けます。
クイック フィックス
Android Studio では、よくある Cloud Endpoints 開発時の誤りを防ぐため、クイック フィックスを用意しています。クイック フィックスの提案を表示するには、Alt + Enter キー(Linux / Windows の場合)または ⌥ + Enter キー(Mac の場合)を押します。たとえば、上記のコードサンプルで示した @Named
アノテーションが欠落しているという問題については、次のようなクイック フィックスが表示されます。
このリストから最初のクイック フィックス(Add @Named
)を選択すると、@Named
がメソッド パラメータに追加されます。