Menulis dan menganotasi kode

Halaman ini menjelaskan cara menyusun dan memberi anotasi pada kode Cloud Endpoints Frameworks Anda. Untuk mengetahui daftar lengkap semua anotasi yang didukung, lihat Anotasi.

Sebelum memulai

  1. Siapkan lingkungan pengembangan Anda.

  2. Clone contoh kerangka Endpoints Frameworks:

     git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git

  3. Contoh kerangka Endpoints Frameworks terletak di:

     cd appengine-java8/endpoints-v2-skeleton/

Untuk membantu menjelaskan cara kerja anotasi, dokumen ini menggunakan contoh endpoints-v2-backend untuk menunjukkan anotasi dan kode lain yang harus Anda tambahkan ke contoh endpoints-v2-skeleton agar dapat di-build. Pada akhirnya, contoh endpoints-v2-skeleton yang diubah berperilaku sama dengan contoh endpoints-v2-backend, yang digunakan dalam Mulai menggunakan Framework Endpoint di App Engine.

Membuat dan menganotasi kode

Untuk memberi anotasi pada kode Anda:

  1. Ubah direktori ke direktori sumber Java project, misalnya: src/main/java/com/example/skeleton.
  2. Buat file class JavaBean bernama Message.java yang berisi kode berikut: 
    public class Message {

  private String message;

  public String getMessage() {
    return this.message;
  }

  public void setMessage(String message) {
    this.message = message;
  }
}
  3. Edit file MyApi.java yang ada dalam contoh kerangka. Ubah anotasi definisi @Api dengan kode berikut: 
    @Api(
    name = "echo",
    version = "v1",
    namespace =
    @ApiNamespace(
        ownerDomain = "echo.example.com",
        ownerName = "echo.example.com",
        packagePath = ""
    ),
    // ...
)

    Atribut version = "v1" menentukan versi API contoh. Nilai yang Anda masukkan akan menjadi bagian dari jalur di URL ke API Anda. Untuk mengetahui informasi selengkapnya tentang versi, lihat Menangani pembuatan versi API.

  4. Tambahkan metode echo berikut sebagai endpoint API pertama dan metode bantuan doEcho ke MyApi.java Anda. 
    @ApiMethod(name = "echo")
public Message echo(Message message, @Named("n") @Nullable Integer n) {
  return doEcho(message, n);
}
     
    private Message doEcho(Message request, Integer n) {
  Message response = new Message();
  if (n != null && n >= 0) {
    StringBuilder sb = new StringBuilder();
    for (int i = 0; i < n; i++) {
      if (i > 0) {
        sb.append(' ');
      }
      sb.append(request.getMessage());
    }
    response.setMessage(sb.toString());
  }
  return response;
}
  5. Salin semua impor dari Echo.java, lalu tempelkan di MyApi.java Anda.

  6. Maven

    Buat project:

    mvn clean package

    Gradle

    Buat project:

    gradle clean build

Dasar-dasar anotasi

Ada tiga anotasi yang umum digunakan di API backend:

  • @Api berisi detail konfigurasi backend API.
  • @ApiMethod menandai metode class yang merupakan bagian dari backend API. Metode yang tidak ditandai dengan @ApiMethod tidak disertakan saat Anda membuat library klien dan dokumen penemuan. Anotasi @ApiMethod juga dapat digunakan untuk mengganti konfigurasi API untuk metode tertentu.
  • @Named harus ditambahkan ke semua parameter yang diteruskan ke metode sisi server, kecuali parameter tersebut adalah jenis entity.

Untuk mengetahui daftar lengkap semua anotasi Endpoints Frameworks, lihat Anotasi dan sintaksis.

Langkah berikutnya