Panduan memulai API Gateway dan App Engine

Halaman ini menunjukkan cara menyiapkan Gateway API untuk mengelola dan mengamankan layanan backend App Engine.

{i>Task List <i}(Daftar Tugas)

Gunakan daftar tugas berikut saat Anda mengerjakan tutorial. Semua tugas diperlukan untuk men-deploy Gateway API untuk layanan backend App Engine Anda.

1. Membuat atau memilih project Google Cloud.
2. Jika Anda belum men-deploy App Engine Anda sendiri, deploy aplikasi contoh. Lihat Sebelum memulai.
3. Aktifkan layanan Gateway API yang diperlukan.
4. Konfigurasikan IAP untuk mengamankan aplikasi Anda. Lihat Mengonfigurasi IAP.
5. Buat spesifikasi OpenAPI yang mendeskripsikan API Anda, dan konfigurasikan rute ke App Engine Anda. Lihat Membuat konfigurasi API.
6. Deploy Gateway API menggunakan konfigurasi API Anda. Lihat Men-deploy Gateway API.
7. Lacak aktivitas ke aplikasi Anda. Lihat Aktivitas Tracking API.
8. Hindari menimbulkan tagihan ke akun Google Cloud Anda. Lihat Pembersihan.

Sebelum memulai

1. Di konsol Google Cloud, buka halaman Dashboard dan pilih atau buat project Google Cloud.

   Buka halaman Dashboard

   Catatan: Jika Anda tidak berencana untuk menyimpan resource yang dibuat dalam tutorial ini, buat project baru, bukan memilih project yang ada. Setelah menyelesaikan langkah-langkah ini, Anda dapat menghapus project, sehingga semua resource yang terkait dengan project tersebut akan dihapus.

2. Pastikan penagihan diaktifkan untuk project Anda.

   Pelajari cara mengaktifkan penagihan

3. Catat ID project yang ingin Anda gunakan untuk tutorial ini. Di bagian lain halaman ini, project ID ini disebut sebagai PROJECT_ID.

4. Mendownload dan menginstal Google Cloud CLI.

   Mendownload gcloud CLI

5. Update komponen gcloud:

   gcloud components update

6. Tetapkan project default. Ganti PROJECT_ID dengan ID project Google Cloud Anda

   gcloud config set project PROJECT_ID

7. Jika Anda belum men-deploy aplikasi App Engine sendiri, ikuti langkah-langkah dalam Panduan Memulai App Engine untuk bahasa Anda agar dapat menggunakan Google Cloud CLI untuk memilih atau membuat project Google Cloud dan men-deploy aplikasi contoh. Catat URL aplikasi, serta region dan project ID tempat aplikasi Anda di-deploy.

Mengaktifkan layanan yang diperlukan

Gateway API mengharuskan Anda mengaktifkan layanan Google berikut:

Nama	Judul
apigateway.googleapis.com	API Gateway API
servicemanagement.googleapis.com	Service Management API
servicecontrol.googleapis.com	Service Control API

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 apigateway.googleapis.com
gcloud services enable servicemanagement.googleapis.com
gcloud services enable servicecontrol.googleapis.com

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

Mengonfigurasi IAP untuk mengamankan aplikasi Anda

Untuk mengamankan aplikasi App Engine, Anda harus menggunakan Identity Aware Proxy (IAP) untuk memastikan bahwa permintaan diautentikasi. Proses ini mencakup penetapan anggota yang akan diberi peran IAP-secured Web App User yang diperlukan untuk project tersebut.

Ikuti langkah-langkah untuk Mengaktifkan IAP, dan pastikan Anda dapat login ke aplikasi.

Catatan: Setelah IAP diaktifkan untuk aplikasi App Engine, pastikan untuk mencatat OAuth 2.0 client_id. Ini akan digunakan sebagai IAP_CLIENT_ID nanti dalam tutorial ini. Untuk menemukan OAuth 2.0 client_id untuk aplikasi App Engine Anda, buka halaman APIs & Services > Credentials di Konsol Google Cloud. Salin Client ID untuk aplikasi Anda dari bagian Client ID OAuth 2.0 pada halaman tersebut.

Membuat konfigurasi API

Sebelum Gateway API dapat digunakan untuk mengelola traffic ke backend App Engine yang di-deploy, Gateway API memerlukan konfigurasi API.

Anda dapat membuat konfigurasi API menggunakan spesifikasi OpenAPI yang berisi anotasi khusus untuk menentukan perilaku API Gateway yang diinginkan. Anda harus menambahkan kolom khusus Google yang berisi URL untuk setiap aplikasi App Engine, sehingga Gateway API memiliki informasi yang diperlukan untuk memanggil aplikasi.

1. Buat file teks bernama openapi2-appengine.yaml. (Untuk memudahkan, halaman ini mengacu pada spesifikasi OpenAPI berdasarkan nama file tersebut, tetapi Anda dapat menamainya dengan nama lain jika mau.)
2. Cantumkan setiap aplikasi Anda di bagian paths pada file openapi2-appengine.yaml, seperti yang ditunjukkan di bawah ini:

   # openapi2-appengine.yaml
   swagger: '2.0'
   info:
     title: API_ID optional-string
     description: Sample API on API Gateway with an App Engine backend
     version: 1.0.0
   schemes:
     - https
   produces:
     - application/json
   paths:
     /hello:
       get:
         summary: Greet a user
         operationId: hello
         x-google-backend:
           address: APP_URL
           jwt_audience: IAP_CLIENT_ID
         responses:
           '200':
             description: A successful response
             schema:
               type: string

3. Di kolom title, ganti API_ID dengan nama API Anda dan ganti optional-string dengan deskripsi singkat pilihan Anda. Jika API Anda belum ada, perintah untuk membuat API Config juga akan membuat API dengan nama yang Anda tentukan. Nilai kolom title digunakan saat membuat kunci API yang memberikan akses ke API ini. Lihat persyaratan ID API untuk panduan penamaan API.
4. Pada kolom address di bagian x-google-backend, ganti APP_URL dengan URL sebenarnya dari layanan App Engine Anda (jalur lengkap dari API yang dipanggil). Contohnya, https://myapp.an.r.appspot.com/hello

   Ganti IAP_CLIENT_ID dengan Client ID OAuth yang Anda buat saat menyiapkan IAP.

5. Masukkan perintah berikut, dengan kondisi:
   • CONFIG_ID menentukan nama konfigurasi API Anda.
   • API_ID menentukan nama API Anda. Jika API belum ada, perintah ini akan membuatnya.
   • PROJECT_ID menentukan nama project Google Cloud Anda.
   • SERVICE_ACCOUNT_EMAIL menentukan akun layanan yang digunakan untuk menandatangani token bagi backend dengan autentikasi yang dikonfigurasi.

   gcloud api-gateway api-configs create CONFIG_ID \
     --api=API_ID --openapi-spec=openapi2-appengine.yaml \
     --project=PROJECT_ID --backend-auth-service-account=SERVICE_ACCOUNT_EMAIL

   Operasi ini mungkin memerlukan waktu beberapa menit hingga konfigurasi API diterapkan ke sistem downstream. Pembuatan konfigurasi API yang kompleks dapat memerlukan waktu hingga sepuluh menit agar berhasil diselesaikan.

6. Setelah konfigurasi API dibuat, Anda dapat melihat detailnya dengan menjalankan perintah ini:

   gcloud api-gateway api-configs describe CONFIG_ID \
     --api=API_ID --project=PROJECT_ID

Men-deploy Gateway API

Sekarang Anda dapat men-deploy API di Gateway API. Men-deploy API di Gateway API juga menentukan URL eksternal yang dapat digunakan klien API untuk mengakses API Anda.

Jalankan perintah berikut untuk men-deploy konfigurasi API yang baru saja Anda buat ke Gateway API:

gcloud api-gateway gateways create GATEWAY_ID \
  --api=API_ID --api-config=CONFIG_ID \
  --location=GCP_REGION --project=PROJECT_ID

dengan:

• GATEWAY_ID menentukan nama gateway.
• API_ID menentukan nama API Gateway API yang terkait dengan gateway ini.
• CONFIG_ID menentukan nama konfigurasi API yang di-deploy ke gateway.

• GCP_REGION adalah region Google Cloud untuk gateway yang di-deploy.

  Catatan: Nilai yang diizinkan adalah:

  • asia-northeast1
  • australia-southeast1
  • europe-west1
  • europe-west2
  • us-east1
  • us-east4
  • us-central1
  • us-west2
  • us-west3
  • us-west4

  Dukungan untuk gateway Gateway API yang sebelumnya dibuat di asia-east1 akan berakhir pada 1 November 2022. Anda harus meninjau gateway apa pun yang saat ini berjalan di asia-east1 dan menghapus atau membuatnya ulang di lokasi baru sesuai kebutuhan.

• PROJECT_ID menentukan nama project Google Cloud Anda.

Setelah berhasil diselesaikan, Anda dapat menggunakan perintah berikut untuk melihat detail tentang gateway:

gcloud api-gateway gateways describe GATEWAY_ID \
  --location=GCP_REGION --project=PROJECT_ID

Catat nilai properti defaultHostname dalam output perintah ini. Ini adalah bagian nama host URL gateway yang Anda gunakan untuk menguji deployment pada langkah berikutnya.

Menguji deployment API Anda

Sekarang Anda dapat mengirim permintaan ke API menggunakan URL yang dihasilkan setelah deployment gateway.

Masukkan perintah curl berikut, dengan kode berikut:

• DEFAULT_HOSTNAME menentukan bagian nama host URL gateway yang di-deploy. Nilai defaultHostname dapat ditemukan dalam output perintah gateways describe yang ditunjukkan di atas.
• hello adalah jalur yang ditetapkan dalam konfigurasi API Anda.

curl https://DEFAULT_HOSTNAME/hello

Contoh:

curl https://my-gateway-a12bcd345e67f89g0h.uc.gateway.dev/hello

Anda akan melihat output berikut:

My-AppEngineApp: Access denied for user [e-mail] requesting https://my-project.appspot.com/helloGET. If you should have access, contact [e-mail] and include the full text of this message.

Berhasil! Gateway API Anda mengelola akses ke layanan backend App Engine. Untuk memberikan akses ke aplikasi App Engine, Anda harus mengonfigurasi akun layanan dengan izin yang benar untuk Gateway API.

Melacak aktivitas API

1. Lihat grafik aktivitas untuk API Anda di halaman Gateway API di Konsol Google Cloud. Klik API Anda untuk melihat grafik aktivitasnya di halaman Overview. Mungkin perlu waktu beberapa saat agar permintaan ditampilkan dalam grafik.

2. Lihat log permintaan untuk API Anda di halaman Logs Explorer. Link ke halaman Logs Explorer dapat ditemukan di halaman API Gateway pada Konsol Google Cloud.

   Buka halaman Gateway API

   Setelah berada di halaman Gateway API:
   1. Pilih API untuk dilihat.
   2. Klik tab Details.
   3. Klik link di bagian Logs.

Pembersihan

Agar tidak menimbulkan biaya pada akun Google Cloud Anda untuk resource yang digunakan dalam panduan memulai ini, Anda dapat:

• Menghapus gateway Anda
• Menghapus API Anda

Atau, Anda juga dapat menghapus project Google Cloud yang digunakan untuk tutorial ini.