Halaman ini diterjemahkan oleh Cloud Translation API.

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

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

Mendapatkan kode contoh

Untuk mendownload contoh API:

Download kode contoh sebagai file ZIP.
Ekstrak file ZIP dan ubah ke direktori dotnet-docs-samples-master\endpoints\getting-started.
Buka GettingStarted.sln dengan Visual Studio, atau gunakan editor favorit Anda untuk mengedit file di direktori endpoints\getting-started\src\IO.Swagger.

Mengonfigurasi Endpoint

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

Untuk mengonfigurasi Endpoints:

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

Pastikan Anda berada di direktori endpoints/getting-started.

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:

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

Simpan file app.yaml.

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.

Pastikan Anda berada di direktori endpoints/getting-started, tempat file konfigurasi openapi-appengine.yaml Anda berada.
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 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

Setelah men-deploy contoh API, Anda dapat mengirim permintaan ke API tersebut.

Membuat kunci API dan menetapkan variabel lingkungan

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

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
Klik Create credentials, lalu pilih API key.
Salin kunci ke papan klip.
Klik Close.
Di komputer lokal Anda, tempelkan kunci API untuk menetapkannya ke variabel lingkungan: $Env:ENDPOINTS_KEY="AIza..."

Kirim permintaan

Di PowerShell, tetapkan 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"

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

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

Lihat grafik aktivitas untuk API Anda di halaman Endpoints.

Buka halaman Endpoints Services

Mungkin perlu waktu beberapa saat agar permintaan ditampilkan dalam grafik.
Lihat log permintaan untuk API Anda di halaman Logs Explorer.

Buka halaman Logs Explorer