Mulai menggunakan Framework Cloud Endpoints untuk Java


Halaman ini menunjukkan cara mengonfigurasi, men-deploy, dan mengirim permintaan ke contoh API menggunakan Framework Cloud Endpoints untuk Java. Framework Endpoints untuk Java terintegrasi dengan lingkungan runtime Java 8 standar App Engine. Framework Endpoints 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 ini. Semua tugas diperlukan agar berhasil mengirim permintaan ke API.

  1. Siapkan Google Cloud project. Lihat Sebelum 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. Buat file konfigurasi OpenAPI. Lihat Mengonfigurasi Cloud Endpoints.
  5. Deploy konfigurasi Endpoints untuk membuat layanan Endpoints. Lihat Men-deploy konfigurasi Endpoints.
  6. Jalankan sampel di komputer Anda. Lihat Menjalankan contoh secara lokal.
  7. Buat backend untuk menayangkan API dan men-deploy API. Lihat Men-deploy backend API.
  8. Kirim permintaan ke API. Lihat Mengirim permintaan ke API.
  9. Melacak aktivitas API. Lihat Melacak aktivitas API.
  10. Hindari menimbulkan tagihan ke akun Google Cloud Anda. Lihat Pembersihan.

Biaya

Dalam dokumen ini, Anda akan menggunakan komponen Google Cloudyang dapat ditagih berikut:

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga.

Pengguna Google Cloud baru 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. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Make sure that billing is enabled for your Google Cloud project.

  6. Catat project ID 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 Endpoints Frameworks for Java bergantung pada lingkungan runtime Java 8 standar App Engine, Endpoints Frameworks tidak mendukung versi Java lainnya.
  2. Jika Anda belum memiliki Maven 3.3.9 atau yang lebih baru, download dan instal Maven.
  3. Catatan untuk pengguna Windows: Jika Anda menginstal JDK dan Maven di Windows, instal di direktori yang tidak memiliki spasi di jalur. Lihat Maven di Windows untuk mengetahui informasi selengkapnya.

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

    • Pengguna Linux dan macOS: Tutorial ini memberikan contoh penggunaan curl, yang biasanya sudah diinstal sebelumnya di sistem operasi Anda. Jika Anda belum 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.
  5. Download dan inisialisasi Google Cloud CLI.
  6. Jalankan perintah berikut:
    1. Pastikan gcloud CLI diizinkan untuk mengakses data dan layanan Anda di Google Cloud:
      gcloud auth login
    2. Menggunakan 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 versi terbaru Google Cloud SDK dan semua komponen:
      gcloud components update
  7. Buat aplikasi App Engine:
    1. Tetapkan project default ke project ID Anda.
      gcloud config set project YOUR_PROJECT_ID

      Ganti YOUR_PROJECT_ID dengan Google Cloud project ID Anda. Jika Anda memiliki project Google Cloud lain, dan Anda 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 ID project 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 contoh API 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

Contoh kode mencakup alat Endpoints Frameworks yang menghasilkan file konfigurasi OpenAPI yang menjelaskan REST API contoh kode. Ikuti langkah-langkah di bagian ini untuk mengonfigurasi dan membangun project Maven contoh sehingga Anda dapat membuat file konfigurasi OpenAPI.

Menambahkan project ID ke kode API contoh

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. Cari <endpoints.project.id>, lalu ganti YOUR_PROJECT_ID dengan Google Cloud project ID Anda.

    Contoh:

    <endpoints.project.id>example-project</endpoints.project.id>
    
  3. Simpan perubahan.

Membangun project contoh

Untuk membangun 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 di-build. Jika project berhasil diselesaikan, pesan yang mirip dengan pesan ini akan ditampilkan:

    [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 yang disebut 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 dibuat. Setelah selesai, pesan yang mirip dengan pesan ini akan ditampilkan:

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

    Abaikan pesan apa pun tentang kegagalan memuat class logger statis.

Men-deploy konfigurasi Endpoint

Untuk men-deploy konfigurasi Endpoints, Anda menggunakan Service Infrastructure, platform layanan dasar Google, yang digunakan oleh Endpoints Frameworks dan layanan lainnya untuk membuat dan mengelola API serta 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 dibuat di bagian sebelumnya:

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

Tindakan ini akan membuat layanan Endpoints baru dengan nama dalam format YOUR_PROJECT_ID.appspot.com. Nama ini dikonfigurasi di pom.xml dan file konfigurasi lain yang disertakan dalam contoh. Perhatikan bahwa saat Anda men-deploy API di App Engine, data DNS 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, Service Management akan menampilkan informasi ke terminal. Anda dapat mengabaikan peringatan tentang jalur di openapi.json yang tidak memerlukan kunci API dengan aman. Setelah berhasil diselesaikan, baris yang mirip dengan berikut 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, Endpoints Frameworks memerlukan layanan berikut:
Nama Judul
servicemanagement.googleapis.com Service Management API
servicecontrol.googleapis.com Service Control API

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

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

  • Anda men-deploy konfigurasi Endpoints ke projectGoogle Cloud yang sudah ada tempat layanan ini dinonaktifkan secara eksplisit.

Gunakan perintah berikut untuk mengonfirmasi bahwa layanan yang diperlukan sudah 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

Aktifkan juga layanan Endpoints Anda:

gcloud services enable ENDPOINTS_SERVICE_NAME

Untuk menentukan ENDPOINTS_SERVICE_NAME, Anda dapat:

  • Setelah men-deploy konfigurasi Endpoints, buka halaman Endpoints di Konsol Cloud. Daftar ENDPOINTS_SERVICE_NAME yang mungkin ditampilkan di kolom Nama layanan.

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

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

Menjalankan contoh secara lokal

Setelah men-deploy konfigurasi Endpoints, 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 berikut, ganti YOUR_PROJECT_ID dengan Google Cloud project ID 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 untuk digunakan bagi 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

Pada 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 tanda petik terbalik. Saat Anda menempelkan contoh ke PowerShell, pastikan tidak ada spasi setelah tanda petik terbalik. Untuk mengetahui informasi tentang opsi yang digunakan dalam contoh permintaan, lihat Invoke-WebRequest dalam dokumentasi Microsoft.

API akan mengembalikan pesan yang Anda kirimkan, dan merespons dengan berikut ini:

{
 "message": "hello world"
}

Men-deploy backend API

Sejauh ini Anda telah men-deploy konfigurasi OpenAPI ke Service Management, tetapi Anda belum men-deploy kode yang melayani backend API. Bagian ini memandu Anda 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 mengotorisasi 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 Anda saat App Engine diinisialisasi 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 Google Cloud project ID Anda:

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

Pada 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 Google Cloud project ID 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 tanda petik terbalik. Saat Anda menempelkan contoh ke PowerShell, pastikan tidak ada spasi setelah tanda petik terbalik. Untuk mengetahui 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 kode berikut:
    {"message":"hello world"}
  • Masukkan URL ke aplikasi contoh. Contoh:
    https://example-project-12345.appspot.com/_ah/api/echo/v1/echo

API akan mengembalikan pesan yang Anda kirimkan, dan merespons dengan berikut ini:

{
 "message": "hello world"
}

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

Anda baru saja men-deploy dan menguji API di Endpoints Frameworks.

Melacak aktivitas API

  1. Lihat grafik aktivitas untuk API Anda di konsol Google Cloud di halaman Endpoints > Service.

    Buka halaman Endpoints Services

    Mungkin perlu waktu beberapa saat agar permintaan ditampilkan 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 Cloud Endpoints Portal untuk membuat portal developer, sebuah situs yang dapat Anda gunakan untuk berinteraksi dengan contoh API. Untuk mempelajari lebih lanjut, lihat Ringkasan Cloud Endpoints Portal.

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.

  1. In the Google Cloud console, go to the Manage resources page.

    Go to Manage resources

  2. In the project list, select the project that you want to delete, and then click Delete.
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

Langkah berikutnya