Mulai menggunakan Framework Cloud Endpoints untuk Java

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

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:

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

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

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.

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

(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

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.

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.