Tutorial ini menunjukkan cara mengonfigurasi dan men-deploy API contoh dan Extensible Service Proxy (ESP) yang berjalan pada instance di 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 Endpoint dan arsitektur Endpoint.
Tujuan
Gunakan daftar tugas tingkat tinggi berikut saat Anda mengerjakan tutorial. Semua tugas diperlukan agar berhasil mengirim permintaan ke API.
- Siapkan project Google Cloud, instal software yang diperlukan, dan buat aplikasi App Engine. Lihat Sebelum memulai.
- Download kode contoh. Lihat Mendapatkan kode contoh.
- Konfigurasi file
openapi-appengine.yaml
, yang digunakan untuk mengonfigurasi Endpoint. Lihat Mengonfigurasi Endpoint. - Deploy konfigurasi Endpoint untuk membuat layanan Endpoint. Lihat Men-deploy konfigurasi Endpoint.
- Men-deploy API dan ESP ke App Engine. Lihat Men-deploy backend API.
- Mengirim permintaan ke API. Lihat Mengirim permintaan ke API.
- Melacak aktivitas API. Lihat Aktivitas Tracking API.
- Menghindari timbulnya tagihan ke akun Google Cloud Anda. Lihat Pembersihan.
Biaya
Dalam dokumen ini, Anda menggunakan komponen Google Cloud yang dapat ditagih berikut:
Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda,
gunakan kalkulator harga.
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
- Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.
-
Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.
-
Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.
-
Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.
-
Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.
- Catat project ID karena diperlukan nanti.
-
Anda memerlukan aplikasi untuk mengirim permintaan ke API contoh.
- Pengguna Linux dan macOS: Tutorial ini memberikan contoh penggunaan
curl
, yang biasanya telah diinstal sebelumnya di sistem operasi Anda. Jika tidak memilikicurl
, Anda dapat mendownloadnya daricurl
Halaman rilis dan download. - Pengguna Windows: Tutorial ini memberikan contoh menggunakan
Invoke-WebRequest
, yang didukung di PowerShell 3.0 dan yang lebih baru.
- Pengguna Linux dan macOS: Tutorial ini memberikan contoh penggunaan
- Download Google Cloud CLI.
-
Update gcloud CLI dan instal komponen Endpoint.
gcloud components update
-
Pastikan Google Cloud CLI (
gcloud
) diberi otorisasi untuk mengakses data dan layanan Anda di Google Cloud:gcloud auth login
Di tab browser baru yang terbuka, pilih akun. -
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 ingin menggunakan
gcloud
untuk mengelolanya, lihat Mengelola konfigurasi CLI gcloud. - Pilih region tempat Anda ingin membuat aplikasi App Engine. Jalankan perintah berikut untuk mendapatkan daftar region:
gcloud app regions list
- Buat aplikasi App Engine.
Ganti YOUR_PROJECT_ID dengan project ID 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 atau mendownload contoh API:
- Kode contoh menggunakan Maven. Jika Anda tidak memiliki Maven 3.3.9 atau yang lebih baru, download dan instal Maven.
- Clone repositori aplikasi contoh ke komputer lokal Anda:
git clone https://github.com/GoogleCloudPlatform/java-docs-samples
Atau, download sampel sebagai file zip dan ekstrak.
- Ubah ke direktori yang berisi kode contoh:
cd java-docs-samples/endpoints/getting-started
Untuk meng-clone atau mendownload contoh API:
- Clone repositori aplikasi contoh ke komputer lokal Anda:
git clone https://github.com/GoogleCloudPlatform/python-docs-samples
Atau, download sampel sebagai file zip dan ekstrak.
- Ubah ke direktori yang berisi kode contoh:
cd python-docs-samples/endpoints/getting-started
Untuk meng-clone atau mendownload contoh API:
- Pastikan
variabel lingkungan
GOPATH
Anda ditetapkan. - Clone repositori aplikasi contoh ke komputer lokal Anda:
go get -d github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
- Ubah ke direktori yang berisi kode contoh:
cd $GOPATH/src/github.com/GoogleCloudPlatform/golang-samples/endpoints/getting-started
Untuk meng-clone atau mendownload contoh API:
- Clone repositori aplikasi contoh ke komputer lokal Anda:
git clone https://github.com/GoogleCloudPlatform/php-docs-samples
Atau, download sampel sebagai file zip dan ekstrak.
- Ubah ke direktori yang berisi kode contoh:
cd php-docs-samples/endpoints/getting-started
Untuk meng-clone atau mendownload contoh API:
- Clone repositori aplikasi contoh ke komputer lokal Anda:
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples
Atau, download sampel sebagai file zip dan ekstrak.
- Ubah ke direktori yang berisi kode contoh:
cd ruby-docs-samples/endpoints/getting-started
Untuk meng-clone atau mendownload contoh API:
- Clone repositori aplikasi contoh ke komputer lokal Anda:
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples
Atau, download sampel sebagai file zip dan ekstrak.
- Ubah ke direktori yang berisi kode contoh:
cd nodejs-docs-samples/endpoints/getting-started
Mengonfigurasi Endpoint
Kode contoh mencakup file konfigurasi OpenAPI,
openapi-appengine.yaml
, yang didasarkan pada
Spesifikasi OpenAPI v2.0.
- Di direktori kode contoh, buka file konfigurasi
openapi-appengine.yaml
.Java Python Mulai PHP Ruby NodeJS Perhatikan hal-hal berikut:
- Contoh konfigurasi menampilkan garis di dekat kolom
host
, yang perlu Anda ubah. Untuk men-deployopenapi-appengine.yaml
ke Endpoint, diperlukan dokumen OpenAPI lengkap. - 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 tanpa bahasa. File
openapi-appengine.yaml
yang sama ada dalam contohgetting-started
di setiap repositori GitHub bahasa demi kemudahan.
- Contoh konfigurasi menampilkan garis di dekat kolom
- Pada baris yang berisi kolom
host
, ganti YOUR-PROJECT-ID dengan project ID Google Cloud Anda. Contoh:host: "example-project-12345.appspot.com"
Endpoint 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 Endpoint, lihat Mengonfigurasi Endpoint.
Men-deploy konfigurasi Endpoint
Untuk men-deploy konfigurasi Endpoint, gunakan perintah gcloud endpoints
services deploy
. Perintah ini menggunakan Service Management untuk membuat layanan terkelola.
Untuk men-deploy konfigurasi Endpoint:
- Pastikan Anda berada di direktori
endpoints/getting-started
. - Upload konfigurasi dan buat layanan terkelola:
gcloud endpoints services deploy openapi-appengine.yaml
Kemudian, perintah gcloud
akan memanggil Service Management API untuk membuat layanan terkelola dengan nama yang Anda tentukan di kolom host
pada file openapi-appengine.yaml
.
Pengelolaan Layanan mengonfigurasi layanan sesuai dengan setelan dalam file openapi-appengine.yaml
. Saat membuat perubahan pada
openapi-appengine.yaml
, Anda harus men-deploy ulang file untuk mengupdate
layanan Endpoint.
Saat membuat dan mengonfigurasi layanan, Pengelolaan Layanan akan menghasilkan 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, Pengelolaan Layanan akan menampilkan pesan yang berisi ID konfigurasi layanan dan nama layanan, seperti berikut:
Service Configuration [2017-02-13r0] uploaded for service [example-project-12345.appspot.com]
Pada contoh sebelumnya, 2017-02-13r0
adalah ID konfigurasi layanan, dan example-project-12345.appspot.com
adalah layanan Endpoint. ID konfigurasi layanan terdiri dari
stempel tanggal diikuti dengan nomor revisi. Jika Anda men-deploy file openapi-appengine.yaml
lagi pada hari yang sama, nomor revisi akan bertambah di ID konfigurasi layanan. Anda dapat melihat konfigurasi layanan Endpoints di halaman Endpoint > Services di Konsol Google Cloud.
Jika Anda mendapatkan pesan error, lihat Memecahkan masalah deployment konfigurasi Endpoint.
Memeriksa layanan yang diperlukan
Setidaknya, Endpoint dan ESP mewajibkan pengaktifan layanan Google berikut:Nama | Judul |
---|---|
servicemanagement.googleapis.com |
Service Management API |
servicecontrol.googleapis.com |
Service Control API |
endpoints.googleapis.com |
Endpoint Google Cloud |
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 telah men-deploy konfigurasi Endpoint ke project Google Cloud yang ada, tempat layanan ini dinonaktifkan secara eksplisit.
Gunakan perintah berikut 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 servicemanagement.googleapis.comgcloud services enable servicecontrol.googleapis.com
gcloud services enable endpoints.googleapis.com
Aktifkan juga layanan Endpoint Anda:
gcloud services enable ENDPOINTS_SERVICE_NAME
Untuk menentukan ENDPOINTS_SERVICE_NAME, Anda dapat:
Setelah men-deploy konfigurasi Endpoint, buka halaman Endpoint di Konsol Cloud. Daftar kemungkinan ENDPOINTS_SERVICE_NAME ditampilkan di bawah kolom Nama layanan.
Untuk OpenAPI, ENDPOINTS_SERVICE_NAME adalah nilai yang Anda tentukan dalam kolom
host
pada spesifikasi OpenAPI. Untuk gRPC, ENDPOINTS_SERVICE_NAME adalah nilai yang Anda tentukan di kolomname
pada konfigurasi Endpoint gRPC Anda.
Untuk mengetahui informasi selengkapnya tentang perintah gcloud
, lihat
layanan gcloud
.
Men-deploy backend API
Sejauh ini Anda telah men-deploy dokumen OpenAPI ke Pengelolaan Layanan, tetapi belum men-deploy kode yang menayangkan backend API. Bagian ini akan memandu Anda dalam men-deploy contoh API dan ESP ke App Engine.
Untuk men-deploy backend API:
- Tambahkan nama layanan ke file
app.yaml
:Java Buka file
endpoints/getting-started/src/main/appengine/app.yaml
.Python Buka file
endpoints/getting-started/app.yaml
.Mulai Buka file
endpoints/getting-started/app.yaml
.PHP Buka file
endpoints/getting-started/app.yaml
.Ruby Buka file
endpoints/getting-started/app.yaml
.NodeJS Buka file
endpoints/getting-started/app.yaml
.Ganti ENDPOINTS-SERVICE-NAME dengan nama layanan Endpoint Anda. Nama ini sama dengan yang Anda konfigurasikan dalam 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 yang terakhir di-deploy. Saat Anda menentukan opsi ini, hingga 5 menit setelah Anda men-deploy konfigurasi layanan baru, ESP akan mendeteksi perubahan tersebut dan mulai menggunakannya secara otomatis. Sebaiknya tentukan opsi ini, bukan ID konfigurasi khusus untuk digunakan ESP. - Simpan file
app.yaml
. - Pastikan Anda berada di direktori
endpoints/getting-started
. Di sinilah file konfigurasiopenapi-appengine.yaml
Anda berada. - Jalankan perintah berikut untuk men-deploy contoh API dan ESP ke App Engine:
Karena bagian endpoints_api_service
disertakan dalam file app.yaml
, perintah gcloud app deploy
men-deploy dan mengonfigurasi ESP dalam container terpisah ke lingkungan fleksibel App Engine Anda. Semua traffic permintaan dirutekan melalui ESP, dan melakukan proxy permintaan serta respons ke dan dari penampung yang menjalankan kode server backend Anda.
Deploy menggunakan Maven:
mvn appengine:stage gcloud app deploy target/appengine-staging
gcloud app deploy
gcloud app deploy
gcloud app deploy
gcloud app deploy
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 selagi App Engine melakukan inisialisasi sepenuhnya.
Jika Anda mendapatkan pesan error, lihat Memecahkan masalah deployment fleksibel App Engine.
Untuk informasi selengkapnya, lihat Men-deploy backend API.
Mengirim permintaan ke API
Setelah layanan berjalan di App Engine, Anda dapat mengirim permintaan ke layanan tersebut.
Membuat kunci API dan menetapkan variabel lingkungan
Kode contoh memerlukan kunci API. Untuk menyederhanakan permintaan, Anda harus menetapkan variabel lingkungan untuk kunci API.
Dalam 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 project Google Cloud lain, baca artikel Mengaktifkan API di project Google Cloud.
- Klik Create credentials, lalu pilih API key.
- Salin kunci ke papan klip.
- Klik Close.
- Di komputer lokal Anda, tempel kunci API untuk menetapkannya ke variabel
lingkungan:
- Di Linux atau macOS:
export ENDPOINTS_KEY=AIza...
- Di Windows PowerShell:
$Env:ENDPOINTS_KEY="AIza..."
- Di Linux atau macOS:
Mengirim permintaan
Linux atau Mac OS
Buat variabel lingkungan untuk URL project App Engine Anda. Ganti YOUR_PROJECT_ID dengan project ID Google Cloud Anda:
export ENDPOINTS_HOST=https://YOUR_PROJECT_ID.appspot.com
Kirim permintaan HTTP menggunakan variabel lingkungan
ENDPOINTS_HOST
danENDPOINTS_KEY
yang telah Anda tetapkan sebelumnya:curl --request POST \ --header "content-type:application/json" \ --data '{"message":"hello world"}' \ "${ENDPOINTS_HOST}/echo?key=${ENDPOINTS_KEY}"
Dalam curl
sebelumnya:
- Opsi
--data
menentukan data yang akan diposting ke API. - Opsi
--header
menentukan bahwa data dalam format JSON.
PowerShell
Buat variabel lingkungan untuk URL project App Engine Anda. Ganti YOUR_PROJECT_ID dengan project ID Google Cloud Anda:
$Env:ENDPOINTS_HOST="https://YOUR_PROJECT_ID.appspot.com"
Kirim permintaan HTTP menggunakan variabel lingkungan
ENDPOINTS_HOST
danENDPOINTS_KEY
yang telah 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 {i>backtick<i}. Saat Anda menempelkan contoh ke PowerShell, pastikan tidak ada spasi setelah tanda kutip terbalik. Untuk 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 nilaiapplication/json
. - Untuk isi, masukkan informasi 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 menggemakan kembali pesan yang Anda kirimkan, dan merespons dengan hal berikut:
{
"message": "hello world"
}
Jika Anda tidak mendapatkan respons yang berhasil, lihat Memecahkan masalah error respons.
Anda baru saja men-deploy dan menguji API di Endpoint.
Aktivitas API pelacakan
Melihat grafik aktivitas untuk API Anda di halaman Endpoint.
Mungkin perlu waktu beberapa saat agar permintaan tersebut ditampilkan dalam grafik.
Lihat log permintaan untuk API Anda di halaman Logs Explorer.
Membuat portal developer untuk API
Anda dapat menggunakan Portal Cloud Endpoints untuk membuat portal developer, yaitu situs yang dapat digunakan untuk berinteraksi dengan contoh API. Untuk mempelajari lebih lanjut, lihat Ringkasan Portal Cloud Endpoints.
Pembersihan
Agar tidak dikenakan 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-nya.
Lihat Menghapus instance API dan API untuk mengetahui informasi tentang cara menghentikan layanan yang digunakan oleh tutorial ini.