Memulai Cloud Endpoints di lingkungan fleksibel App Engine (.NET) dengan ESP

---

Tutorial ini menunjukkan cara mengonfigurasi dan men-deploy contoh .NET core API 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.

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 Endpoint. Lihat Mengonfigurasi Endpoint.
4. Deploy konfigurasi Endpoint untuk membuat layanan Endpoint. Lihat Men-deploy konfigurasi Endpoint.
5. Deploy contoh API dan ESP ke App Engine. Lihat Men-deploy backend API.
6. Mengirim permintaan ke API. Lihat Mengirim permintaan ke API.
7. Melacak aktivitas API. Lihat Aktivitas Tracking API.
8. Menghindari timbulnya tagihan ke akun Google Cloud Anda. Lihat Pembersihan.

Biaya

Dalam dokumen ini, Anda menggunakan komponen Google Cloud yang dapat ditagih berikut:

• App Engine
• Endpoint

Untuk membuat perkiraan biaya berdasarkan proyeksi penggunaan Anda, gunakan kalkulator harga. Pengguna baru Google Cloud 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. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

3. Make sure that billing is enabled for your Google Cloud project.

4. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

5. Make sure that billing is enabled for your Google Cloud project.

6. Catat project ID karena diperlukan nanti.
7. Tutorial ini memerlukan .NET Core 2.x SDK, yang dapat Anda gunakan dengan editor teks apa pun. Meskipun Integrated Development Environment (IDE) tidak diperlukan, demi kenyamanan, sebaiknya gunakan salah satu IDE berikut:
   • Visual Studio Code, yang berjalan di macOS, Linux, dan Windows. Jika menggunakan Visual Studio Code, Anda juga harus menginstal .NET Core 2.x.
   • Visual Studio 2017 untuk Windows, yang mencakup .NET Core 2.x. Jika Anda menggunakan Visual Studio 2017, sebaiknya gunakan plugin Google Cloud Tools for Visual Studio, yang mengintegrasikan deployment App Engine dalam IDE.
   • Visual Studio untuk Mac, yang mencakup .NET Core 2.x.

8. Anda memerlukan aplikasi untuk mengirim permintaan ke API contoh. Tutorial ini memberikan contoh menggunakan Invoke-WebRequest, yang didukung di PowerShell 3.0 dan yang lebih baru.

9. Download Google Cloud CLI.
10. Update gcloud CLI dan instal komponen Endpoint.

    gcloud components update

11. 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.
12. Tetapkan project default ke project ID Anda.

    gcloud config set project YOUR_PROJECT_ID

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

13. Pilih region tempat Anda ingin membuat aplikasi App Engine. Jalankan perintah berikut untuk mendapatkan daftar region:

    gcloud app regions list

14. 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 mendownload contoh API:

1. Download kode contoh sebagai file zip.

2. Ekstrak file zip dan ubah ke direktori dotnet-docs-samples-master\endpoints\getting-started.

3. Buka GettingStarted.sln dengan Visual Studio, atau gunakan editor favorit Anda untuk mengedit file dalam direktori endpoints\getting-started\src\IO.Swagger.

Mengonfigurasi Endpoint

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

Untuk mengonfigurasi Endpoint:

1. Di direktori kode contoh, buka file konfigurasi openapi-appengine.yaml.
   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-hal berikut:

   • Contoh konfigurasi menampilkan garis di dekat kolom host, yang perlu Anda ubah. Untuk men-deploy openapi-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 contoh getting-started di setiap repositori GitHub bahasa demi kemudahan.

2. 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:

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 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.com
gcloud 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 kolom name 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:

1. Buka file endpoints/getting-started/src/IO.Swagger/app.yaml, lalu tambahkan nama layanan Anda:
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=[PROJECT-ID].appspot.com'
  # where [PROJECT-ID].appspot.com is your Endpoints service name.
  name: ENDPOINTS-SERVICE-NAME
  rollout_strategy: managed

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.

2. Simpan file app.yaml.

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.

3. Pastikan Anda berada di direktori endpoints/getting-started, yang merupakan tempat file konfigurasi openapi-appengine.yaml Anda berada.
4. Deploy contoh API dan ESP ke App Engine:

    dotnet restore
    dotnet publish
    gcloud app deploy src\IO.Swagger\bin\Debug\netcoreapp2.0\publish\app.yaml

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 men-deploy contoh API, Anda dapat mengirim permintaan ke API tersebut.

Membuat kunci API dan menetapkan variabel lingkungan

Kode contoh memerlukan kunci API. Untuk menyederhanakan permintaan, Anda harus menetapkan variabel lingkungan untuk kunci API.

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

   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, tempel kunci API untuk menetapkannya ke variabel lingkungan: $Env:ENDPOINTS_KEY="AIza..."

Mengirim permintaan

1. Di PowerShell, tetapkan variabel lingkungan untuk URL project App Engine. Ganti YOUR_PROJECT_ID dengan project ID Google Cloud Anda.

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

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

   Invoke-WebRequest "$ENDPOINTS_HOST/echo?key=$ENDPOINTS_KEY" `
     -Body '{"message": "hello world"}' -Method POST `
     -ContentType "application/json"
   

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.

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.

Catatan: Jika Anda ingin memberi tahu kami apa yang Anda sukai dari tutorial ini, jangan ragu untuk memberikan masukan di bagian bawah halaman ini. Masukan Anda membantu kami meningkatkan kualitas tutorial ini.
Jika terjadi error, bergabunglah dengan grup Google google-cloud-endpoints dan beri tahu kami apa masalahnya. Grup ini menerima respons dari pengguna Endpoint lain dan dari engineer Google, yang memantau grup.

Aktivitas API pelacakan

1. Melihat grafik aktivitas untuk API Anda di halaman Endpoint.

   Buka halaman Layanan Endpoint

   Mungkin perlu waktu beberapa saat agar permintaan tersebut ditampilkan dalam grafik.

2. Lihat log permintaan untuk API Anda di halaman Logs Explorer.

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

Langkah selanjutnya

• Membagikan API Anda kepada developer lain
• Pelajari autentikasi lebih lanjut
• Pelajari opsi dukungan komunitas