Mulai menggunakan Cloud Endpoints untuk Compute Engine dengan ESPv2

OpenAPI   |  gRPC

Tutorial ini menunjukkan cara mengonfigurasi dan men-deploy sampel API dan Extensible Service Proxy V2 (ESPv2) yang berjalan dalam container Docker bawaan di Compute 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.

Membuat instance Compute Engine

Untuk membuat instance Compute Engine:

1. In the Google Cloud console, go to the Create an instance page.

   Go to Create an instance

2. Di bagian Firewall, pilih Izinkan traffic HTTP dan Izinkan traffic HTTPS.
3. Untuk membuat VM, klik Create.



Tunggu hingga instance memulai. Setelah siap, instance akan tercantum di halaman VM Instances dengan ikon status hijau.

4. Pastikan Anda dapat terhubung ke instance VM.
   1. In the list of virtual machine instances, click SSH in the row of the instance that you want to connect to.
   2. Sekarang Anda dapat menggunakan terminal untuk menjalankan perintah Linux di instance Debian.
   3. Masukkan exit untuk memutuskan koneksi dari instance.
5. Catat nama instance, zona, dan alamat IP eksternal karena akan diperlukan nanti.

Mendownload kode contoh

Download kode contoh ke komputer lokal Anda.

Java

Untuk meng-clone atau mendownload API contoh:

1. Clone repositori aplikasi contoh ke komputer lokal Anda:

   git clone https://github.com/GoogleCloudPlatform/java-docs-samples

   Atau, download contoh sebagai file ZIP dan ekstrak.

2. 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 dan 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 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 dan 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 dan 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 dan ekstrak.

2. Ubah ke direktori yang berisi kode contoh:

   cd nodejs-docs-samples/endpoints/getting-started

Mengonfigurasi Endpoint

Kode contoh menyertakan file konfigurasi OpenAPI, openapi.yaml, yang didasarkan pada Spesifikasi OpenAPI v2.0. Anda mengonfigurasi dan men-deploy openapi.yaml di komputer lokal Anda. Untuk mengonfigurasi Endpoints:

1. Di direktori kode contoh, buka file konfigurasi openapi.yaml.
   Java

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Python

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Mulai

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   PHP

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Ruby

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   NodeJS

   swagger: "2.0"
   info:
     description: "A simple Google Cloud Endpoints API example."
     title: "Endpoints Example"
     version: "1.0.0"
   host: "echo-api.endpoints.YOUR-PROJECT-ID.cloud.goog"

   Perhatikan hal berikut:

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

2. Di kolom host, ganti teks dengan nama layanan Endpoints, yang harus dalam format berikut:

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"

   Ganti YOUR_PROJECT_ID dengan Google Cloud project ID Anda. Contoh:

   host: "echo-api.endpoints.example-project-12345.cloud.goog"

Perhatikan bahwa echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog adalah nama layanan Endpoints. Ini bukan nama domain yang sepenuhnya memenuhi syarat (FQDN) yang Anda gunakan untuk mengirim permintaan ke API.

Untuk mengetahui informasi tentang kolom dalam dokumen OpenAPI yang diperlukan Endpoints, lihat Mengonfigurasi Endpoints. Setelah Anda menyelesaikan semua langkah konfigurasi berikut sehingga Anda dapat berhasil mengirim permintaan ke contoh API menggunakan alamat IP, lihat Mengonfigurasi DNS Endpoint untuk mengetahui informasi tentang cara mengonfigurasi echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog agar menjadi FQDN.

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.yaml
   

Kemudian, perintah gcloud memanggil Service Management API untuk membuat layanan terkelola dengan nama yang Anda tentukan di kolom host file openapi.yaml. Service Management mengonfigurasi layanan sesuai dengan setelan dalam file openapi.yaml. Saat membuat perubahan pada openapi.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.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 [echo-api.endpoints.example-project-12345.cloud.goog]

Dalam contoh sebelumnya, 2017-02-13r0 adalah ID konfigurasi layanan, dan echo-api.endpoints.example-project-12345.cloud.goog adalah layanan Endpoints. ID konfigurasi layanan terdiri dari stempel tanggal yang diikuti dengan nomor revisi. Jika Anda men-deploy file openapi.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 menyiapkan Docker di instance VM dan menjalankan kode backend API dan ESPv2 dalam container Docker.

Memeriksa izin yang diperlukan

Catatan:

Langkah ini tidak diperlukan jika instance Compute Engine dibuat dengan akun layanan default Compute Engine dan telah diberi semua izin yang diperlukan.

• Di konsol Google Cloud , buka halaman instance Compute Engine.

  Buka halaman Compute Engine

• Pilih instance Anda dari daftar.
• Anda dapat melihat akun layanan terkait dan izin yang dimilikinya.

• Berikan izin yang diperlukan ke akun layanan:

  gcloud projects add-iam-policy-binding PROJECT_NAME \
    --member "serviceAccount:SERVICE_ACCOUNT" \
    --role roles/servicemanagement.serviceController
  

  Untuk mengetahui informasi selengkapnya, lihat Apa yang dimaksud dengan peran dan izin?

Instal Docker di instance VM

Untuk menginstal Docker di instance VM:

1. Tetapkan zona untuk project Anda dengan menjalankan perintah:

   gcloud config set compute/zone YOUR_INSTANCE_ZONE
   

   Ganti YOUR_INSTANCE_ZONE dengan zona tempat instance Anda berjalan.

2. Hubungkan ke instance Anda menggunakan perintah berikut:

   gcloud compute ssh INSTANCE_NAME
   

   Ganti INSTANCE_NAME dengan nama instance VM Anda.

3. Lihat dokumentasi Docker untuk menyiapkan repositori Docker. Pastikan untuk mengikuti langkah-langkah yang sesuai dengan versi dan arsitektur instance VM Anda:
   • Jessie atau yang lebih baru
   • x86_64 / amd64

Menjalankan API dan ESPv2 di container Docker

ESPv2 adalah proxy berbasis Envoy yang berada di depan kode backend Anda. Proxy memproses traffic masuk untuk menyediakan autentikasi, pengelolaan kunci API, logging, dan fitur pengelolaan Endpoints API lainnya. Untuk menginstal dan menjalankan contoh API dan ESPv2 di container Docker:

1. Buat jaringan container Anda sendiri yang disebut esp_net.

   sudo docker network create --driver bridge esp_net
   

2. Jalankan server Echo contoh yang melayani contoh API:
   Java

   sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-java:1.0
   

   Python

   sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-python:1.0
   

   Mulai

   sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-go:1.0
   

   PHP

   sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-php:1.0
   

   Ruby

   sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-ruby:1.0
   

   NodeJS

   sudo docker run --detach --name=echo --net=esp_net gcr.io/google-samples/echo-node:1.0
   

3. Jalankan container Docker ESPv2 publik yang telah dipaketkan sebelumnya. Di opsi startup ESPv2, ganti SERVICE_NAME dengan nama layanan Anda. Nama ini sama dengan nama yang Anda konfigurasi di kolom host dokumen OpenAPI Anda.

   sudo docker run \
       --detach \
       --name=esp \
       --publish=80:9000 \
       --net=esp_net \
       gcr.io/endpoints-release/endpoints-runtime:2 \
       --service=SERVICE_NAME \
       --rollout_strategy=managed \
       --listener_port=9000 \
       --backend=http://echo:8080
   

   Opsi --rollout_strategy=managed mengonfigurasi ESPv2 untuk menggunakan konfigurasi layanan yang di-deploy terbaru. Saat Anda menentukan opsi ini, dalam waktu satu menit setelah Anda men-deploy konfigurasi layanan baru, ESPv2 akan mendeteksi perubahan dan otomatis mulai menggunakannya. Sebaiknya tentukan opsi ini, bukan memberikan ID konfigurasi tertentu untuk digunakan ESPv2. Untuk mengetahui informasi tentang opsi ESPv2 lainnya yang digunakan di atas, lihat Opsi startup ESPv2.

Jika Anda menerima pesan error, lihat Memecahkan masalah Endpoints di Compute Engine. Lihat Men-deploy Backend API untuk mengetahui informasi tambahan.

Mengirim permintaan menggunakan alamat IP

Setelah API contoh dan ESPv2 berjalan di instance Compute Engine, Anda dapat mengirim permintaan ke API dari mesin lokal.

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

Gunakan curl untuk mengirim permintaan HTTP menggunakan variabel lingkungan ENDPOINTS_KEY yang Anda tetapkan sebelumnya. Ganti IP_ADDRESS dengan alamat IP eksternal instance Anda.

curl --request POST \
   --header "content-type:application/json" \
   --data '{"message":"hello world"}' \
   "http://IP_ADDRESS:80/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

Gunakan Invoke-WebRequest untuk mengirim permintaan HTTP dengan menggunakan variabel lingkungan ENDPOINTS_KEY yang Anda tetapkan sebelumnya. Ganti IP_ADDRESS dengan alamat IP eksternal instance Anda.

(Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' `
    -Headers @{"content-type"="application/json"} `
    -URI "http://IP_ADDRESS:80/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 kunci API yang sebenarnya, bukan variabel lingkungan. Contoh:
  http://192.0.2.0:80/echo?key=AIza...

API akan mengembalikan pesan yang Anda kirim, 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.

Catatan: Jika Anda ingin memberi tahu kami apa yang Anda sukai tentang tutorial ini, silakan berikan masukan di bagian bawah halaman ini. Masukan Anda membantu kami meningkatkan kualitas tutorial ini.
Jika Anda mendapatkan error, bergabunglah ke grup Google google-cloud-endpoints dan beri tahu kami apa yang salah. Grup ini menerima respons dari pengguna Endpoints lainnya dan dari engineer Google, yang memantau grup.

Mengonfigurasi DNS untuk Endpoint

Karena nama layanan Endpoints untuk API berada di domain .endpoints.YOUR_PROJECT_ID.cloud.goog, Anda dapat menggunakannya sebagai nama domain yang sepenuhnya memenuhi syarat (FQDN) dengan melakukan sedikit perubahan konfigurasi dalam file openapi.yaml. Dengan cara ini, Anda dapat mengirim permintaan ke contoh API dengan menggunakan echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog alih-alih alamat IP.

Untuk mengonfigurasi DNS Endpoints:

1. Buka file konfigurasi OpenAPI Anda, openapi.yaml, lalu tambahkan properti x-google-endpoints di tingkat teratas file (tidak diindentasi atau bertingkat) seperti yang ditunjukkan dalam cuplikan berikut:

   host: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
   x-google-endpoints:
   - name: "echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog"
     target: "IP_ADDRESS"

2. Di properti name, ganti YOUR_PROJECT_ID dengan project ID Anda.
3. Di properti target, ganti IP_ADDRESS dengan alamat IP yang Anda gunakan saat mengirim permintaan ke contoh API.
4. Deploy file konfigurasi OpenAPI yang telah diupdate ke Service Management:

   gcloud endpoints services deploy openapi.yaml
   

Misalnya, asumsikan file openapi.yaml telah dikonfigurasi sebagai berikut:

host: "echo-api.endpoints.example-project-12345.cloud.goog"
x-google-endpoints:
- name: "echo-api.endpoints.example-project-12345.cloud.goog"
  target: "192.0.2.1"

Saat Anda men-deploy file openapi.yaml menggunakan perintah gcloud sebelumnya, Service Management akan membuat data A DNS, echo-api.endpoints.my-project-id.cloud.goog, yang di-resolve ke alamat IP target, 192.0.2.1. Mungkin perlu waktu beberapa menit agar konfigurasi DNS baru diterapkan.

Mengonfigurasi SSL

Untuk mengetahui detail selengkapnya tentang cara mengonfigurasi DNS dan SSL, lihat Mengaktifkan SSL untuk Endpoint.

Mengirim permintaan menggunakan FQDN

Setelah mengonfigurasi data DNS untuk contoh API, kirim permintaan ke API tersebut menggunakan FQDN (ganti YOUR_PROJECT_ID dengan project ID Anda) dan variabel lingkungan ENDPOINTS_KEY yang ditetapkan sebelumnya:

• Di Linux atau mac OS:

  curl --request POST \
      --header "content-type:application/json" \
      --data '{"message":"hello world"}' \
      "http://echo-api.endpoints.YOUR_PROJECT_ID.cloud.goog:80/echo?key=${ENDPOINTS_KEY}"

• Di Windows PowerShell:

  (Invoke-WebRequest -Method POST -Body '{"message": "hello world"}' -Headers @{"content-type"="application/json"} -URI "http://echo-api.endpoints.[YOUR_PROJECT_ID].cloud.goog:80/echo?key=$Env:ENDPOINTS_KEY").Content

Melacak aktivitas API

Untuk melacak aktivitas API:

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

   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