Memulai Cloud Endpoints untuk lingkungan fleksibel App Engine dengan ESP

Tutorial ini menunjukkan cara mengonfigurasi dan men-deploy API sampel dan Extensible Service Proxy (ESP) yang berjalan di instance dalam lingkungan fleksibel App Engine. REST API kode contoh dijelaskan menggunakan spesifikasi OpenAPI. Tutorial ini juga menunjukkan cara membuat kunci API dan menggunakannya dalam permintaan ke API.

Untuk ringkasan Cloud Endpoints, lihat Tentang Endpoints dan Arsitektur Endpoints.

Tujuan

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

  1. Siapkan project Google Cloud , instal software yang diperlukan, dan buat aplikasi App Engine. Lihat Sebelum memulai.
  2. Download kode contoh. Lihat Mendapatkan kode contoh.
  3. Konfigurasi file openapi-appengine.yaml, yang digunakan untuk mengonfigurasi Endpoints. Lihat Mengonfigurasi Endpoint.
  4. Deploy konfigurasi Endpoints untuk membuat layanan Endpoints. Lihat Men-deploy konfigurasi Endpoints.
  5. Deploy API dan ESP ke App Engine. Lihat Men-deploy backend API.
  6. Kirim permintaan ke API. Lihat Mengirim permintaan ke API.
  7. Melacak aktivitas API. Lihat Melacak aktivitas API.
  8. 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.

  7. 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.
  8. Download Google Cloud CLI.
  9. Update gcloud CLI dan instal komponen Endpoints. 
    gcloud components update
  10. Pastikan Google Cloud CLI (gcloud) diizinkan untuk mengakses data dan layanan Anda di Google Cloud: 
    gcloud auth login
     Di tab browser baru yang terbuka, pilih akun.
  11. Tetapkan project default ke project ID Anda. 
    gcloud config set project YOUR_PROJECT_ID

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

  12. Pilih region tempat Anda ingin membuat aplikasi App Engine. Jalankan perintah berikut untuk mendapatkan daftar region: 
    gcloud app regions list
  13. Buat aplikasi App Engine. Ganti YOUR_PROJECT_ID dengan Google Cloud project ID 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

Java

Untuk meng-clone atau mendownload API contoh:

  1. Kode contoh menggunakan Maven. Jika Anda belum memiliki Maven 3.3.9 atau yang lebih baru, download dan instal Maven.
  2. Clone repositori aplikasi contoh ke komputer lokal Anda: 
    git clone https://github.com/GoogleCloudPlatform/java-docs-samples

    Atau, download contoh sebagai file ZIP, lalu ekstrak.

  3. Ubah ke direktori yang berisi kode contoh: 
    cd java-docs-samples/endpoints/getting-started
Python

Untuk meng-clone atau mendownload API contoh:

  1. Clone repositori aplikasi contoh ke komputer lokal Anda: 
    git clone https://github.com/GoogleCloudPlatform/python-docs-samples

    Atau, download contoh sebagai file ZIP, lalu ekstrak.

  2. Ubah ke direktori yang berisi kode contoh: 
    cd python-docs-samples/endpoints/getting-started
Mulai

Untuk meng-clone atau mendownload API contoh:

  1. Pastikan variabel lingkungan GOPATH Anda telah ditetapkan.
  2. Clone repositori aplikasi contoh ke komputer lokal Anda: 
    go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
  3. Ubah ke direktori yang berisi kode contoh: 
    cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
PHP

Untuk meng-clone atau mendownload API contoh:

  1. Clone repositori aplikasi contoh ke komputer lokal Anda: 
    git clone https://github.com/GoogleCloudPlatform/php-docs-samples

    Atau, download contoh sebagai file ZIP, lalu ekstrak.

  2. Ubah ke direktori yang berisi kode contoh: 
    cd php-docs-samples/endpoints/getting-started
Ruby

Untuk meng-clone atau mendownload API contoh:

  1. Clone repositori aplikasi contoh ke komputer lokal Anda: 
    git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples

    Atau, download contoh sebagai file ZIP, lalu ekstrak.

  2. Ubah ke direktori yang berisi kode contoh: 
    cd ruby-docs-samples/endpoints/getting-started
NodeJS

Untuk meng-clone atau mendownload API contoh:

  1. Clone repositori aplikasi contoh ke komputer lokal Anda: 
    git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples

    Atau, download contoh sebagai file ZIP, lalu ekstrak.

  2. Ubah ke direktori yang berisi kode contoh: 
    cd nodejs-docs-samples/endpoints/getting-started

Mengonfigurasi Endpoint

Contoh kode mencakup file konfigurasi OpenAPI, openapi-appengine.yaml, yang didasarkan pada Spesifikasi OpenAPI v2.0.

Untuk mengonfigurasi Endpoints:
  1. Di direktori kode contoh, buka file konfigurasi openapi-appengine.yaml

    Java
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"
    Python
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"
    Mulai
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"
    PHP
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"
    Ruby
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"
    NodeJS
    swagger: "2.0"
info:
  description: "A simple Google Cloud Endpoints API example."
  title: "Endpoints Example"
  version: "1.0.0"
host: "YOUR-PROJECT-ID.appspot.com"

    Perhatikan hal berikut:

    • Contoh konfigurasi menampilkan baris di dekat kolom host yang perlu Anda ubah. Untuk men-deploy openapi-appengine.yaml ke Endpoints, dokumen OpenAPI lengkap diperlukan.
    • Contoh openapi-appengine.yaml berisi bagian untuk mengonfigurasi autentikasi yang tidak diperlukan untuk tutorial ini. Anda tidak perlu mengonfigurasi baris dengan YOUR-SERVICE-ACCOUNT-EMAIL dan YOUR-CLIENT-ID.
    • OpenAPI adalah spesifikasi yang tidak bergantung pada bahasa. File openapi-appengine.yaml yang sama ada di contoh getting-started di repositori GitHub setiap bahasa untuk memudahkan.

  2. Pada baris dengan kolom host, ganti YOUR-PROJECT-ID dengan ID project Google Cloud Anda. Contoh: 
    host: "example-project-12345.appspot.com"

Endpoints menggunakan teks yang dikonfigurasi di kolom host sebagai nama layanan. Saat Anda men-deploy API ke backend App Engine, entri DNS dengan nama dalam format YOUR-PROJECT-ID.appspot.com akan dibuat secara otomatis.

Untuk mengetahui informasi tentang kolom dalam dokumen OpenAPI yang diperlukan Endpoints, lihat Mengonfigurasi Endpoints.

Men-deploy konfigurasi Endpoint

Untuk men-deploy konfigurasi Endpoints, Anda menggunakan perintah gcloud endpoints services deploy. Perintah ini menggunakan Service Management untuk membuat layanan terkelola.

Untuk men-deploy konfigurasi Endpoints:

  1. Pastikan Anda berada di direktori endpoints/getting-started.
  2. Upload konfigurasi dan buat layanan terkelola: 
    gcloud endpoints services deploy openapi-appengine.yaml

Kemudian, perintah gcloud memanggil Service Management API untuk membuat layanan terkelola dengan nama yang Anda tentukan di kolom host file openapi-appengine.yaml. Service Management mengonfigurasi layanan sesuai dengan setelan dalam file openapi-appengine.yaml. Saat membuat perubahan pada openapi-appengine.yaml, Anda harus men-deploy ulang file untuk memperbarui layanan Endpoints.

Saat membuat dan mengonfigurasi layanan, Service Management menampilkan informasi ke terminal. Anda dapat mengabaikan peringatan tentang jalur dalam file openapi-appengine.yaml yang tidak memerlukan kunci API dengan aman. Setelah selesai mengonfigurasi layanan, Service Management akan menampilkan pesan dengan ID konfigurasi layanan dan nama layanan, yang mirip dengan berikut ini:

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

Dalam contoh sebelumnya, 2017-02-13r0 adalah ID konfigurasi layanan, dan example-project-12345.appspot.com adalah layanan Endpoints. ID konfigurasi layanan terdiri dari stempel tanggal yang diikuti dengan nomor revisi. Jika Anda men-deploy file openapi-appengine.yaml lagi pada hari yang sama, nomor revisi akan bertambah dalam ID konfigurasi layanan. Anda dapat melihat konfigurasi layanan Endpoints di halaman Endpoints > Services di Google Cloud console.

Jika Anda menerima pesan error, lihat Memecahkan masalah deployment konfigurasi Endpoint.

Memeriksa layanan yang diperlukan

Minimal, Endpoints dan ESP memerlukan layanan Google berikut diaktifkan:
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.

Men-deploy backend API

Sejauh ini Anda telah men-deploy dokumen OpenAPI ke Service Management, tetapi Anda belum men-deploy kode yang melayani backend API. Bagian ini memandu Anda men-deploy contoh API dan ESP ke App Engine.

Untuk men-deploy backend API:

  1. Tambahkan nama layanan Anda ke file app.yaml:

    Java

    Buka file endpoints/getting-started/src/main/appengine/app.yaml.

    endpoints_api_service:
  # The following values are to be replaced by information from the output of
  # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
  name: ENDPOINTS-SERVICE-NAME
  rollout_strategy: managed

    Python

    Buka file endpoints/getting-started/app.yaml.

    endpoints_api_service:
  # The following values are to be replaced by information from the output of
  # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
  name: ENDPOINTS-SERVICE-NAME
  rollout_strategy: managed

    Mulai

    Buka file endpoints/getting-started/app.yaml.

    endpoints_api_service:
  # The following values are to be replaced by information from the output of
  # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
  name: ENDPOINTS-SERVICE-NAME
  rollout_strategy: managed

    PHP

    Buka file endpoints/getting-started/app.yaml.

    endpoints_api_service:
  # The following values are to be replaced by information from the output of
  # 'gcloud endpoints services deploy openapi-appengine.yaml' command. If you have
  # previously run the deploy command, you can list your existing configuration
  # ids using the 'configs list' command as follows:
  #
  #     gcloud endpoints configs list --service=YOUR-PROJECT-ID.appspot.com
  #
  name: ENDPOINTS-SERVICE-NAME
  rollout_strategy: managed

    Ruby

    Buka file endpoints/getting-started/app.yaml.

    endpoints_api_service:
  # The following values are to be replaced by information from the output of
  # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
  name: ENDPOINTS-SERVICE-NAME
  rollout_strategy: managed

    NodeJS

    Buka file endpoints/getting-started/app.yaml.

    endpoints_api_service:
  # The following values are to be replaced by information from the output of
  # 'gcloud endpoints services deploy openapi-appengine.yaml' command.
  name: ENDPOINTS-SERVICE-NAME
  rollout_strategy: managed

    Ganti ENDPOINTS-SERVICE-NAME dengan nama layanan Endpoints Anda. Ini adalah nama yang sama dengan yang Anda konfigurasi di kolom host pada dokumen OpenAPI Anda. Contoh: 

    endpoints_api_service:
  name: example-project-12345.appspot.com
  rollout_strategy: managed

    Opsi rollout_strategy: managed mengonfigurasi ESP untuk menggunakan konfigurasi layanan terbaru yang di-deploy. Saat Anda menentukan opsi ini, hingga 5 menit setelah Anda men-deploy konfigurasi layanan baru, ESP akan mendeteksi perubahan dan otomatis mulai menggunakannya. Sebaiknya tentukan opsi ini, bukan ID konfigurasi tertentu yang akan digunakan ESP.

  2. Simpan file app.yaml.

    3. Karena bagian endpoints_api_service disertakan dalam file app.yaml, perintah gcloud app deploy men-deploy dan mengonfigurasi ESP dalam penampung terpisah ke lingkungan fleksibel App Engine Anda. Semua traffic permintaan dirutekan melalui ESP, dan ESP membuat proxy permintaan dan respons ke dan dari penampung yang menjalankan kode server backend Anda.

  3. Pastikan Anda berada di direktori endpoints/getting-started. Di sinilah file konfigurasi openapi-appengine.yaml Anda berada.
  4. Jalankan perintah berikut untuk men-deploy API contoh dan ESP ke App Engine:

    5. Java

    Men-deploy menggunakan Maven:

    mvn appengine:stage
gcloud app deploy target/appengine-staging
    Python
    gcloud app deploy
    Mulai
    gcloud app deploy
    PHP
    gcloud app deploy
    Ruby
    gcloud app deploy
    NodeJS
    gcloud app deploy

    Perintah gcloud app deploy membuat data DNS dalam format YOUR_PROJECT_ID.appspot.com, yang Anda gunakan saat mengirim permintaan ke API. Sebaiknya tunggu beberapa menit sebelum mengirim permintaan ke API Anda saat App Engine diinisialisasi sepenuhnya.

Jika Anda menerima pesan error, lihat Memecahkan masalah deployment fleksibel App Engine.

Untuk mengetahui informasi selengkapnya, lihat Men-deploy backend API.

Mengirim permintaan ke API

Sekarang setelah layanan berjalan di App Engine, Anda dapat mengirim permintaan ke layanan tersebut.

Membuat kunci API dan menetapkan variabel lingkungan

Contoh kode memerlukan kunci API. Untuk menyederhanakan permintaan, Anda menetapkan variabel lingkungan untuk kunci API.

  1. Di project Google Cloud yang sama dengan yang Anda gunakan untuk API, buat kunci API di halaman kredensial API. Jika Anda ingin membuat kunci API di Google Cloud project lain, lihat Mengaktifkan API di Google Cloud project Anda.

    Buka halaman Kredensial

  2. Klik Create credentials, lalu pilih API key.
  3. Salin kunci ke papan klip.
  4. Klik Close.
  5. Di komputer lokal Anda, tempelkan kunci API untuk menetapkannya ke variabel lingkungan:
    • Di Linux atau macOS: export ENDPOINTS_KEY=AIza...
    • Di Windows PowerShell: $Env:ENDPOINTS_KEY="AIza..."

Kirim permintaan

Linux atau Mac OS

  1. Buat variabel lingkungan untuk URL project App Engine Anda. Ganti YOUR_PROJECT_ID dengan Google Cloud project ID Anda:

    export ENDPOINTS_HOST=https://YOUR_PROJECT_ID.appspot.com

  2. Kirim permintaan HTTP menggunakan variabel lingkungan ENDPOINTS_HOST dan ENDPOINTS_KEY yang Anda tetapkan sebelumnya:

    curl --request POST \
  --header "content-type:application/json" \
  --data '{"message":"hello world"}' \
  "${ENDPOINTS_HOST}/echo?key=${ENDPOINTS_KEY}"

Pada curl sebelumnya:

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

PowerShell

  1. Buat variabel lingkungan untuk URL project App Engine Anda. Ganti YOUR_PROJECT_ID dengan Google Cloud project ID Anda:

    $Env:ENDPOINTS_HOST="https://YOUR_PROJECT_ID.appspot.com"

  2. Kirim permintaan HTTP menggunakan variabel lingkungan ENDPOINTS_HOST dan ENDPOINTS_KEY yang Anda tetapkan sebelumnya:

    (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "$Env:ENDPOINTS_HOST/echo?key=$Env:ENDPOINTS_KEY").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"}
  • Di URL, gunakan alamat appspot.com dan kunci API yang sebenarnya, bukan variabel lingkungan. Contoh:
    https://example-project-12345.appspot.com/echo?key=AIza...

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.

Melacak aktivitas API

  1. Lihat grafik aktivitas untuk API Anda di halaman Endpoints.

    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

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.

Lihat Menghapus API dan instance API untuk mengetahui informasi tentang cara menghentikan layanan yang digunakan oleh tutorial ini.

Langkah berikutnya