Panduan memulai API Gateway dan App Engine

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

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. Buat atau pilih Google Cloud project.
2. Jika Anda belum men-deploy App Engine Anda sendiri, deploy aplikasi contoh. Lihat Sebelum memulai.
3. Aktifkan layanan API Gateway yang diperlukan.
4. Konfigurasi IAP untuk mengamankan aplikasi Anda. Lihat Mengonfigurasi IAP.
5. Buat deskripsi OpenAPI yang mendeskripsikan API Anda, dan konfigurasi rute ke App Engine Anda. Lihat Membuat konfigurasi API.
6. Deploy gateway API menggunakan konfigurasi API Anda. Lihat Men-deploy API Gateway.
7. Melacak aktivitas ke aplikasi Anda. Lihat Melacak aktivitas API.
8. Hindari menimbulkan biaya pada akun Google Cloud Anda. Lihat Pembersihan.

Sebelum memulai

1. Di konsol Google Cloud , buka halaman Dasbor, lalu pilih atau buat project Google Cloud .

   Buka halaman Dasbor

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

2. Pastikan penagihan diaktifkan untuk project Anda.

   Mengaktifkan penagihan

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

4. Download dan instal Google Cloud CLI.

   Download gcloud CLI

5. Perbarui komponen gcloud:

   gcloud components update

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

   gcloud config set project PROJECT_ID

7. Jika Anda belum men-deploy aplikasi App Engine sendiri, ikuti langkah-langkah dalam Mulai Cepat App Engine untuk bahasa Anda guna 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

Gunakan perintah berikut untuk mengaktifkan layanan ini:

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 memverifikasi bahwa permintaan diautentikasi. Proses ini mencakup penentuan anggota yang harus diberi peran IAP-secured Web App User yang diperlukan untuk project.

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

Catatan: Setelah IAP diaktifkan untuk aplikasi App Engine, pastikan untuk mencatat client_id OAuth 2.0. 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 di halaman.

Membuat konfigurasi API

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

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

Untuk mengetahui detail selengkapnya tentang ekstensi OpenAPI yang didukung, lihat artikel berikut:

• Ekstensi OpenAPI 2.0 di API Gateway
• Ekstensi OpenAPI 3.x OpenAPI di API Gateway

Untuk membuat konfigurasi API:

1. Buat file teks bernama openapi-appengine.yaml. Untuk mempermudah, halaman ini merujuk pada deskripsi OpenAPI berdasarkan nama file tersebut, tetapi Anda dapat menamainya dengan nama lain jika mau.
2. Salin konten file berikut ke dalam file openapi-run.yaml Anda:

   OpenAPI 2.0

   # openapi-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

   • 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 Konfigurasi API 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 mengetahui pedoman penamaan API.
   • Di kolom address di bagian x-google-backend, ganti APP_URL dengan URL sebenarnya dari layanan App Engine Anda (jalur lengkap API yang dipanggil). Contoh, https://myapp.an.r.appspot.com/hello.

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

   OpenAPI 3.x

   # openapi-appengine.yaml
   openapi: 3.0.4
   info:
     title: API_ID optional-string
     description: Sample API on API Gateway with an App Engine backend
     version: 1.0.0
   # Define reusable components in x-google-api-management
   x-google-api-management:
     backends:
       appengine_backend:
         address: APP_URL
         jwtAudience: IAP_CLIENT_ID
         deadline: 30.0
         pathTranslation: APPEND_PATH_TO_ADDRESS
         protocol: "http/1.1"
   # Apply the backend configuration by referencing it by name. Set at the root so this applies to all operations unless overridden.
   x-google-backend: appengine_backend
   paths:
     /hello:
       get:
         summary: Greet a user
         operationId: hello
         responses:
           '200':
             description: A successful response
             schema:
               type: string

   • 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 Konfigurasi API 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 mengetahui pedoman penamaan API.
   • Di kolom address, ganti APP_URL dengan URL sebenarnya dari layanan App Engine Anda (jalur lengkap API yang dipanggil). Misalnya, https://myapp.an.r.appspot.com/hello.

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

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

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

   Operasi ini mungkin memerlukan waktu beberapa menit untuk selesai karena konfigurasi API disebarkan ke sistem hilir. Pembuatan konfigurasi API yang kompleks dapat memerlukan waktu hingga sepuluh menit agar berhasil diselesaikan.

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

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

Men-deploy gateway API

Sekarang Anda dapat men-deploy API di API Gateway. Men-deploy API di API Gateway 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 API Gateway:

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

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 Google Cloud region 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

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

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

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

Menguji deployment API Anda

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

Masukkan perintah curl berikut, dengan:

• DEFAULT_HOSTNAME menentukan bagian nama host dari URL gateway yang di-deploy. Nilai defaultHostname dapat ditemukan di output perintah gateways describe yang ditampilkan sebelumnya.
• DEFAULT_HOSTNAME menentukan bagian nama host dari URL gateway yang di-deploy. Nilai defaultHostname dapat ditemukan di output perintah gateways describe yang ditampilkan sebelumnya.
• hello adalah jalur yang ditentukan 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 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 Anda.

Melacak aktivitas API

1. Lihat grafik aktivitas untuk API Anda di halaman API Gateway di konsolGoogle Cloud . Klik API Anda untuk melihat grafik aktivitasnya di halaman Ringkasan. 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 di konsol Google Cloud .

   Buka halaman API Gateway

   Setelah berada di halaman API Gateway:
   1. Pilih API yang akan dilihat.
   2. Klik tab Details.
   3. Klik link di bagian Log.

Pembersihan

Agar akun Google Cloud Anda tidak dikenai biaya 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.