Mulai menggunakan Framework Cloud Endpoints untuk Java

---

Halaman ini menunjukkan cara mengonfigurasi, men-deploy, dan mengirim permintaan ke API contoh menggunakan Framework Cloud Endpoints untuk Java. Framework Endpoint untuk Java terintegrasi dengan lingkungan runtime Java 8 standar App Engine. Framework Endpoint terdiri dari alat, library, dan kemampuan yang memungkinkan Anda membuat API dan library klien dari aplikasi App Engine.

Tujuan

Gunakan daftar tugas tingkat tinggi berikut saat Anda mengerjakan tutorial. Semua tugas diperlukan agar berhasil mengirim permintaan ke API.

1. Menyiapkan project Google Cloud. Lihat Sebelum Anda memulai.
2. Instal software yang diperlukan dan buat aplikasi App Engine. Lihat Menginstal dan mengonfigurasi software yang diperlukan.
3. Download kode contoh. Lihat Mendapatkan kode contoh.
4. Membuat file konfigurasi OpenAPI. Lihat Mengonfigurasi Cloud Endpoints.
5. Deploy konfigurasi Endpoint untuk membuat layanan Endpoint. Lihat Men-deploy konfigurasi Endpoint.
6. Jalankan sampel di komputer Anda. Lihat Menjalankan contoh secara lokal.
7. Membuat backend untuk menyalurkan API dan men-deploy API. Lihat Men-deploy backend API.
8. Mengirim permintaan ke API. Lihat Mengirim permintaan ke API.
9. Melacak aktivitas API. Lihat Aktivitas Tracking API.
10. Hindari menimbulkan tagihan ke akun Google Cloud Anda. Lihat Membersihkan.

Biaya

Dalam dokumen ini, Anda menggunakan komponen Google Cloud yang dapat ditagih berikut:

• Endpoint
• App Engine

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga. Pengguna baru Google Cloud mungkin memenuhi syarat untuk mendapatkan uji coba gratis.

Setelah menyelesaikan tugas yang dijelaskan dalam dokumen ini, Anda dapat menghindari penagihan berkelanjutan dengan menghapus resource yang Anda buat. Untuk mengetahui informasi selengkapnya, lihat Pembersihan.

Sebelum memulai

1. Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

2. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

3. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

4. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

5. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.

6. Catat ID project karena akan diperlukan nanti.

Menginstal dan mengonfigurasi software yang diperlukan

1. Jika Anda belum menginstal Java 8, download Java Development Kit (JDK) dari Oracle, lalu instal. Karena Framework Endpoint untuk Java bergantung pada lingkungan runtime Java 8 standar App Engine, Framework Endpoint tidak mendukung Java versi lainnya.
2. Jika Anda tidak memiliki Maven 3.3.9 atau versi yang lebih baru, download dan instal Maven versi tersebut.

Catatan untuk pengguna Windows: Jika Anda menginstal JDK dan Maven di Windows, instal di direktori yang tidak memiliki ruang di jalur. Lihat Maven di Windows untuk mengetahui informasi selengkapnya.

3. Anda memerlukan aplikasi untuk mengirim permintaan ke API contoh.

   • Pengguna Linux dan macOS: Tutorial ini memberikan contoh penggunaan curl, yang biasanya sudah diinstal sebelumnya di sistem operasi Anda. Jika tidak memiliki curl, Anda dapat mendownloadnya dari curl halaman Rilis dan download.
   • Pengguna Windows: Tutorial ini memberikan contoh penggunaan Invoke-WebRequest, yang didukung di PowerShell 3.0 dan yang lebih baru.
4. Download dan lakukan inisialisasi Google Cloud CLI.
5. Jalankan perintah berikut:
   1. Pastikan gcloud CLI diberi otorisasi untuk mengakses data dan layanan Anda di Google Cloud:

      gcloud auth login

   2. Gunakan kredensial default aplikasi:

      gcloud auth application-default login

   3. Instal komponen app-engine-java Google Cloud SDK:

      gcloud components install app-engine-java

   4. Update ke Google Cloud SDK versi terbaru dan semua komponen:

      gcloud components update

6. Buat aplikasi App Engine:
   1. Tetapkan project default ke project ID Anda.

      gcloud config set project YOUR_PROJECT_ID

      Ganti YOUR_PROJECT_ID dengan ID project Google Cloud Anda. Jika Anda memiliki project Google Cloud lain, dan ingin menggunakan gcloud untuk mengelolanya, lihat Mengelola konfigurasi gcloud CLI.

   2. Pilih region tempat Anda ingin membuat aplikasi App Engine. Jalankan perintah berikut untuk mendapatkan daftar region:

      gcloud app regions list

   3. Buat aplikasi App Engine menggunakan perintah berikut. Ganti YOUR_PROJECT_ID dengan project ID Google Cloud Anda dan YOUR_REGION dengan region tempat Anda ingin membuat aplikasi App Engine.

      gcloud app create \
      --project=YOUR_PROJECT_ID \
      --region=YOUR_REGION

Mendapatkan kode contoh

Untuk meng-clone API contoh dari GitHub:

1. Clone repositori contoh ke komputer lokal Anda:

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

2. Ubah ke direktori yang berisi kode contoh:

   cd java-docs-samples/appengine-java8/endpoints-v2-backend
   

Mengonfigurasi Endpoint

Kode contoh mencakup alat Framework Endpoint yang membuat file konfigurasi OpenAPI yang menjelaskan REST API kode contoh. Ikuti langkah-langkah di bagian ini untuk mengonfigurasi dan mem-build project Maven contoh, sehingga Anda nantinya dapat membuat file konfigurasi OpenAPI.

Menambahkan project ID ke contoh kode API

Anda harus menambahkan project ID yang diperoleh saat membuat project ke pom.xml contoh sebelum dapat men-deploy kode.

Untuk menambahkan project ID:

1. Edit file java-docs-samples/appengine-java8/endpoints-v2-backend/pom.xml.

2. Telusuri <endpoints.project.id>, dan ganti YOUR_PROJECT_ID dengan project ID Google Cloud Anda.

   Contoh:

   <endpoints.project.id>example-project</endpoints.project.id>
   

3. Simpan perubahan Anda.

Membuat contoh project

Untuk membuat project:

1. Pastikan Anda berada di direktori java-docs-samples/appengine-java8/endpoints-v2-backend.

2. Jalankan perintah berikut:

   mvn clean package
   

3. Tunggu hingga project selesai dibuat. Ketika project berhasil diselesaikan, pesan yang mirip dengan yang ini akan menampilkan:

   [INFO] BUILD SUCCESS
   [INFO] ------------------------------------------------------------------------
   [INFO] Total time: 14.846s
   [INFO] Finished at: Wed April 13 09:43:09 PDT 2016
   [INFO] Final Memory: 24M/331M
   

Membuat file konfigurasi OpenAPI

Anda menggunakan alat dari library Endpoints Frameworks untuk membuat dokumen OpenAPI bernama openapi.json. File ini menjelaskan REST API kode contoh.

Untuk membuat file konfigurasi OpenAPI:

1. Panggil alat Endpoints Frameworks menggunakan perintah ini:

   mvn endpoints-framework:openApiDocs
   

2. Tunggu hingga spesifikasi konfigurasi di-build. Setelah selesai, pesan yang mirip dengan yang ini akan ditampilkan:

   OpenAPI document written to target/openapi-docs/openapi.json
   

   Abaikan pesan apa pun tentang kegagalan memuat class pencatat log statis.

Men-deploy konfigurasi Endpoint

Untuk men-deploy konfigurasi Endpoint, gunakan Infrastruktur Layanan, yakni platform layanan dasar Google, yang digunakan oleh Framework Endpoint dan layanan lainnya untuk membuat serta mengelola API dan layanan

Untuk men-deploy file konfigurasi:

1. Pastikan Anda berada di direktori java-docs-samples/appengine-java8/endpoints-v2-backend.

2. Deploy file konfigurasi OpenAPI yang dihasilkan di bagian sebelumnya:

   gcloud endpoints services deploy target/openapi-docs/openapi.json
   

Tindakan ini akan membuat layanan Endpoint baru dengan nama dalam format YOUR_PROJECT_ID.appspot.com. Nama ini dikonfigurasi di pom.xml dan file konfigurasi lainnya yang disertakan dalam contoh. Perhatikan bahwa saat Anda men-deploy API di App Engine, data DNS akan dibuat menggunakan format nama YOUR_PROJECT_ID.appspot.com, yang merupakan nama domain yang sepenuhnya memenuhi syarat (FQDN) yang Anda gunakan saat mengirim permintaan ke API.

Saat membuat dan mengonfigurasi layanan, Pengelolaan Layanan menghasilkan informasi ke terminal. Anda dapat mengabaikan peringatan tentang jalur di openapi.json yang tidak memerlukan kunci API dengan aman. Jika berhasil diselesaikan, baris yang mirip dengan berikut ini akan menampilkan ID konfigurasi layanan dan nama layanan:

Service Configuration [2017-02-13-r2] uploaded for service [example-project-12345.appspot.com]

Pada contoh sebelumnya, 2017-02-13-r2 adalah ID konfigurasi layanan dan example-project-12345.appspot.com adalah nama layanan.

Lihat Men-deploy layanan endpoint gcloud untuk mengetahui informasi selengkapnya.

Memeriksa layanan yang diperlukan

Untuk menyediakan pengelolaan API, Framework Endpoint memerlukan layanan berikut:

Nama	Judul
servicemanagement.googleapis.com	Service Management API
servicecontrol.googleapis.com	Service Control API
endpoints.googleapis.com	Google Cloud Endpoints

Dalam sebagian besar kasus, perintah gcloud endpoints services deploy akan mengaktifkan layanan wajib ini. Namun, perintah gcloud berhasil diselesaikan tetapi tidak mengaktifkan layanan yang diperlukan dalam situasi berikut:

• Jika Anda menggunakan aplikasi pihak ketiga seperti Terraform, dan Anda tidak menyertakan layanan ini.

• Anda telah men-deploy konfigurasi Endpoint ke project Google Cloud yang ada, yang menonaktifkan layanan ini secara eksplisit.

Gunakan perintah berikut untuk mengonfirmasi bahwa layanan yang diperlukan telah diaktifkan:

gcloud services list

Jika Anda tidak melihat layanan yang diperlukan tercantum, aktifkan layanan tersebut:

gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com

Aktifkan juga layanan Endpoint Anda:

gcloud services enable ENDPOINTS_SERVICE_NAME

Untuk menentukan ENDPOINTS_SERVICE_NAME, Anda dapat:

• Setelah men-deploy konfigurasi Endpoint, buka halaman Endpoint di Cloud Console. Daftar kemungkinan ENDPOINTS_SERVICE_NAME ditampilkan di bawah kolom Service name.

• Untuk OpenAPI, ENDPOINTS_SERVICE_NAME adalah yang Anda tentukan dalam kolom host pada spesifikasi OpenAPI. Untuk gRPC, ENDPOINTS_SERVICE_NAME adalah yang Anda tentukan di kolom name pada konfigurasi Endpoint gRPC Anda.

Untuk mengetahui informasi selengkapnya tentang perintah gcloud, lihat layanan gcloud.

Menjalankan contoh secara lokal

Setelah men-deploy konfigurasi Endpoint, Anda dapat menjalankan contoh secara lokal.

1. Buat variabel lingkungan bernama ENDPOINTS_SERVICE_NAME, yang digunakan dalam file appengine-web.xml contoh untuk menetapkan nama host. Di contoh berikut, ganti YOUR_PROJECT_ID dengan project ID Google Cloud Anda.

   Di Linux atau Mac OS:

   export ENDPOINTS_SERVICE_NAME=YOUR_PROJECT_ID.appspot.com
   

   Di Windows PowerShell:

   $Env:ENDPOINTS_SERVICE_NAME="YOUR_PROJECT_ID.appspot.com"
   

2. Dapatkan kredensial pengguna baru yang akan digunakan untuk Kredensial Default Aplikasi:

   gcloud auth application-default login
   

3. Jalankan server pengembangan:

   mvn appengine:run
   

   Instance lokal dapat dijangkau di http://localhost:8080 seperti yang ditunjukkan oleh log yang dicetak oleh perintah mvn appengine:run:

   [INFO] GCLOUD: INFO: Module instance default is running at http://localhost:8080/
   

4. Kirim permintaan ke instance lokal:

Linux atau Mac OS

curl \
    --request POST \
    --header "Content-Type: application/json" \
    --data '{"message":"hello world"}' \
    http://localhost:8080/_ah/api/echo/v1/echo

Dalam curl sebelumnya:

• Opsi --data menentukan data yang akan diposting ke API.
• Opsi --header menentukan bahwa data dalam format JSON.

PowerShell

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://localhost:8080/_ah/api/echo/v1/echo").Content

Pada contoh sebelumnya, dua baris pertama diakhiri dengan {i>backtick<i}. Saat Anda menempelkan contoh ke PowerShell, pastikan tidak ada spasi setelah tanda {i>backtick<i}. Untuk informasi tentang opsi yang digunakan dalam contoh permintaan, lihat Invoke-WebRequest dalam dokumentasi Microsoft.

API akan melakukan echo kembali pesan yang Anda kirimkan, dan merespons dengan hal berikut:

{
 "message": "hello world"
}

Men-deploy backend API

Sejauh ini Anda telah men-deploy konfigurasi OpenAPI ke Pengelolaan Layanan, tetapi belum men-deploy kode yang menyalurkan backend API. Bagian ini akan memandu Anda dalam men-deploy contoh API ke App Engine.

Untuk men-deploy backend API:

1. Pastikan Anda berada di direktori java-docs-samples/appengine-java8/endpoints-v2-backend

2. Deploy kode implementasi API menggunakan Maven:

    mvn appengine:deploy
   

   Saat pertama kali mengupload aplikasi contoh, Anda mungkin diminta untuk mengizinkan deployment. Ikuti petunjuknya. Saat Anda melihat jendela browser yang berisi kode, salin kode tersebut ke jendela terminal.

3. Tunggu hingga upload selesai.

   Sebaiknya tunggu beberapa menit sebelum mengirim permintaan ke API selagi App Engine melakukan inisialisasi sepenuhnya.

Mengirim permintaan ke API

Setelah men-deploy API dan file konfigurasinya, Anda dapat mengirim permintaan ke API.

Linux atau Mac OS

Kirim permintaan HTTP menggunakan curl. Ganti [YOUR_PROJECT_ID] dengan project ID Google Cloud Anda:

curl \
    --request POST \
    --header "Content-Type: application/json" \
    --data '{"message":"hello world"}' \
    https://[YOUR_PROJECT_ID].appspot.com/_ah/api/echo/v1/echo

Dalam curl sebelumnya:

• Opsi --data menentukan data yang akan diposting ke API.
• Opsi --header menentukan bahwa data dalam format JSON.

PowerShell

Kirim permintaan HTTP menggunakan Invoke-WebRequest. Ganti [YOUR_PROJECT_ID] dengan project ID Google Cloud Anda:

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} -URI `
     "https://[YOUR_PROJECT_ID].appspot.com/_ah/api/echo/v1/echo").Content

Pada contoh sebelumnya, dua baris pertama diakhiri dengan {i>backtick<i}. Saat Anda menempelkan contoh ke PowerShell, pastikan tidak ada spasi setelah tanda {i>backtick<i}. Untuk informasi tentang opsi yang digunakan dalam contoh permintaan, lihat Invoke-WebRequest dalam dokumentasi Microsoft.

Aplikasi pihak ketiga

Anda dapat menggunakan aplikasi pihak ketiga seperti ekstensi browser Chrome Postman untuk mengirim permintaan:

• Pilih POST sebagai kata kerja HTTP.
• Untuk header, pilih kunci content-type dan nilai application/json.
• Untuk isi, masukkan string berikut:
  {"message":"hello world"}
• Masukkan URL ke aplikasi contoh. Contoh:
  https://example-project-12345.appspot.com/_ah/api/echo/v1/echo

API akan melakukan echo kembali pesan yang Anda kirimkan, dan merespons dengan hal berikut:

{
 "message": "hello world"
}

Jika Anda tidak mendapatkan respons yang berhasil, lihat Memecahkan masalah error respons.

Anda baru saja men-deploy dan menguji API di Framework Endpoint.

Catatan: Jika ingin memberi tahu kami apa yang Anda sukai dari tutorial ini, jangan ragu untuk memberikan masukan di bagian bawah halaman ini. Masukan Anda membantu kami meningkatkan kualitas tutorial ini.
Jika Anda mengalami error, bergabunglah dengan grup Google google-cloud-endpoints dan beri tahu kami apa yang salah. Grup ini menerima respons dari pengguna Endpoint lain dan dari engineer Google, yang memantau grup.

Melacak aktivitas API

1. Lihat grafik aktivitas untuk API Anda di Google Cloud Console di halaman Endpoint > Service.

   Buka halaman Layanan Endpoint

   Mungkin perlu waktu beberapa saat agar permintaan tersebut terlihat dalam grafik.

2. Lihat log permintaan untuk API Anda di halaman Logs Explorer.

   Buka halaman Logs Explorer

Membuat portal developer untuk API

Anda dapat menggunakan Portal Cloud Endpoints untuk membuat portal developer, yaitu situs yang dapat digunakan untuk berinteraksi dengan contoh API. Untuk mempelajari lebih lanjut, lihat Ringkasan Portal Cloud Endpoints.

Pembersihan

Agar tidak perlu membayar biaya pada akun Google Cloud Anda untuk resource yang digunakan dalam tutorial ini, hapus project yang berisi resource tersebut, atau simpan project dan hapus setiap resource.

Perhatian: Menghapus project memiliki efek berikut:
• Semua hal dalam project akan dihapus. Jika menggunakan project yang sudah ada untuk tugas dalam dokumen ini, saat Anda menghapusnya, pekerjaan lain yang telah Anda lakukan dalam project tersebut juga akan terhapus.
• Project ID kustom hilang. Saat membuat project ini, Anda mungkin telah membuat project ID kustom yang ingin digunakan di masa mendatang. Untuk mempertahankan URL yang menggunakan project ID, seperti URL appspot.com, hapus resource yang dipilih di dalam project, bukan menghapus seluruh project.
1. Di konsol Google Cloud, buka halaman Manage resource.

   Buka Manage resource

2. Pada daftar project, pilih project yang ingin Anda hapus, lalu klik Delete.
3. Pada dialog, ketik project ID, lalu klik Shut down untuk menghapus project.

Langkah selanjutnya

• Pelajari arsitektur Framework Endpoint.
• Pelajari anotasi API yang tersedia.
• Pelajari cara menayangkan API dari jalur lain.
• Pelajari cara memantau API.
• Pelajari cara membatasi akses dengan kunci API.
• Pelajari cara menangani pembuatan versi API.
• Pelajari opsi dukungan komunitas.