Panduan cara kerja

Mengonfigurasi dan men-deploy API

• Mengonfigurasi Cloud Endpoints

  Menjelaskan cara menyiapkan dokumen OpenAPI untuk deployment ke Endpoint.

• Men-deploy konfigurasi Endpoint

  Menjelaskan cara men-deploy dokumen OpenAPI ke Endpoint.

• Men-deploy backend API

  Menjelaskan cara men-deploy kode backend API dan Extensible Service Proxy (ESP).

• Men-deploy di Kubernetes

  Menunjukkan cara mengonfigurasi dan men-deploy Endpoint di Kubernetes.

• Menjalankan ESP secara lokal atau di platform lain

  Menunjukkan cara mengonfigurasi instance ESP di komputer lokal atau di penyedia cloud lainnya.

• Membandingkan file konfigurasi

  Menjelaskan tab Histori deployment pada halaman Endpoint > Layanan di Konsol Google Cloud, dan cara membandingkan konfigurasi layanan yang di-deploy dengan versi sebelumnya.

• Mendapatkan nama layanan dan ID konfigurasi

  Menjelaskan cara mendapatkan nama dan ID konfigurasi layanan terkelola.

Pemecahan masalah dan pemantauan

• Ringkasan pemecahan masalah

  Memberikan informasi pemecahan masalah umum dan memberikan link ke halaman lain untuk informasi tambahan.

• Memecahkan masalah deployment konfigurasi Endpoint

  Menjelaskan beberapa error yang mungkin Anda alami saat men-deploy konfigurasi Endpoint dan cara memecahkan masalahnya.

• Memecahkan masalah error respons

  Menjelaskan cara memecahkan masalah error yang Anda terima sebagai respons dari permintaan ke API Anda.

• Memecahkan masalah deployment lingkungan fleksibel App Engine

  Memberikan teknik pemecahan masalah untuk deployment Endpoint di lingkungan fleksibel App Engine.

• Memecahkan masalah deployment Compute Engine

  Memberikan teknik pemecahan masalah untuk deployment Endpoint di Compute Engine.

• Memecahkan masalah deployment GKE

  Memberikan teknik pemecahan masalah untuk deployment Endpoint di GKE.

• Memecahkan masalah validasi JWT

  Memberikan informasi pemecahan masalah jika validasi JWT gagal dan error ditampilkan sebagai respons terhadap klien.

• Memantau API Anda

  Menjelaskan cara memantau kondisi API menggunakan log dan metrik yang dikelola Endpoint untuk Anda secara otomatis.

• Melacak API Anda

  Menjelaskan frekuensi sampling trace, cara memperkirakan biaya untuk Cloud Trace, cara melihat trace di Konsol Google Cloud, dan cara menonaktifkan sampling trace.

Portal Cloud Endpoints

• Ringkasan Portal Endpoint

  Menyediakan ringkasan Portal Endpoint, dan menyertakan link ke situs demo Portal Endpoint.

• Mulai menggunakan Portal Endpoint

  Menjelaskan cara membuat Portal Endpoint dan memperkenalkan antarmuka pengguna Portal Endpoint.

• Mengupdate SmartDocs

  Menjelaskan dokumentasi referensi SmartDocs API, cara SmartDocs menggunakan kolom dalam dokumen OpenAPI untuk membuat dokumentasi API, dan cara membuat ulang SmartDocs.

• Mencoba API

  Menjelaskan cara mengonfigurasi portal agar pengguna dapat mencoba API Anda.

• Menambahkan dokumentasi kustom

  Menjelaskan cara mengubah contoh panduan Memulai, serta cara membuat dan menampilkan halaman dokumentasi tambahan untuk Portal Endpoint Anda.

• Menyinkronkan dokumentasi kustom melalui API

  Menjelaskan cara menggunakan API untuk menyinkronkan dokumentasi kustom ke portal Anda.

• Menyiapkan domain kustom

  Menjelaskan cara menyiapkan Portal Endpoint untuk menggunakan domain kustom.

DNS dan SSL

• Memverifikasi nama domain

  Menunjukkan cara memverifikasi kepemilikan nama domain yang menayangkan Endpoints API.

• Menyajikan API dari nama domain Anda

  Menunjukkan cara menyiapkan project Anda untuk melayani permintaan API.

• Mengonfigurasi DNS di domain cloud.goog

  Menunjukkan cara mengonfigurasi layanan DNS untuk Endpoint yang menggunakan domain cloud.goog, yang dimiliki dan dikelola oleh Google.

• Menyajikan beberapa API dari domain

  Menunjukkan cara menjalankan beberapa API independen di domain Anda.

• Mengaktifkan SSL dengan ESP

  Menunjukkan cara mengaktifkan port SSL untuk layanan Endpoint yang di-deploy menggunakan ESP.

• Mengaktifkan SSL dengan ESPv2

  Menunjukkan cara mengaktifkan port SSL untuk layanan Endpoint yang di-deploy menggunakan ESPv2.

Autentikasi dan kunci API

• Memilih metode autentikasi

  Memberikan ringkasan dan contoh kasus penggunaan untuk setiap metode autentikasi yang didukung.

• Alasan dan waktu menggunakan kunci API

  Memberikan informasi latar belakang tentang kunci API dan kapan menggunakannya.

• Menggunakan Firebase untuk mengautentikasi pengguna

  Menunjukkan cara mengonfigurasi dokumen OpenAPI Anda sehingga ESP memvalidasi permintaan masuk dari klien menggunakan Firebase untuk mengautentikasi pengguna.

• Menggunakan Auth0 untuk mengautentikasi pengguna

  Menunjukkan cara mengonfigurasi dokumen OpenAPI Anda sehingga ESP memvalidasi permintaan masuk dari klien menggunakan Auth0 untuk mengautentikasi pengguna.

• Menggunakan token ID Google untuk mengautentikasi pengguna

  Menunjukkan cara mengonfigurasi dokumen OpenAPI Anda sehingga ESP memvalidasi permintaan masuk dari klien menggunakan token ID Google untuk mengautentikasi pengguna.

• Menggunakan metode kustom untuk mengautentikasi pengguna

  Menunjukkan cara mengonfigurasi dokumen OpenAPI Anda sehingga ESP memvalidasi permintaan masuk dari klien menggunakan penyedia kustom untuk mengautentikasi pengguna.

• Autentikasi antarlayanan

  Menunjukkan cara mengautentikasi panggilan antarlayanan.

• Membatasi akses dengan kunci API

  Menunjukkan cara mencegah aplikasi dan layanan klien yang tidak sah mengakses API Anda.

Mengelola akses API

• Ringkasan akses API

  Menjelaskan opsi kontrol akses API yang tersedia untuk Anda di Endpoint.

• Mengontrol siapa yang dapat mengaktifkan API Anda

  Menunjukkan cara mengontrol siapa yang dapat mengaktifkan API Anda di project Google Cloud mereka sendiri.

• Mengaktifkan API di project Google Cloud Anda

  Menunjukkan cara mengaktifkan API di project Google Cloud.

• Memberikan dan mencabut akses ke API

  Menunjukkan cara memberikan tingkat akses yang berbeda sehingga anggota tim lain dapat membantu mengelola API.

Pengelolaan siklus proses API

• Ringkasan pengelolaan siklus proses API

  Menjelaskan fitur pembuatan versi Endpoints API dan memberikan praktik terbaik untuk pembuatan versi dan staging Endpoints API Anda.

• Menghapus API dan instance

  Menunjukkan cara menghapus API dan instance penonaktifan yang menjalankan API untuk menghindari biaya yang tidak perlu.

• Memulihkan layanan terkelola

  Menunjukkan cara memulihkan layanan terkelola jika penghapusan yang tidak disengaja.

Membatasi permintaan API (beta)

• Tentang kuota

  Memberikan ringkasan fungsi utama yang diberikan oleh kuota.

• Mengonfigurasi kuota

  Menjelaskan cara mengonfigurasi kuota untuk API Anda.

• Mengganti batas kuota default

  Menjelaskan cara menetapkan batas kuota yang berbeda untuk project konsumen tertentu.

Menyesuaikan ESP

• Menggunakan nginx.conf kustom di Google Kubernetes Engine

  Menjelaskan cara membuat file nginx.conf kustom untuk men-deploy ESP ke GKE.

• Membuat nginx.conf kustom untuk mendukung CORS

  Menunjukkan contoh cara penulisan opsi ESP CORS ke nginx.conf sebagai titik awal jika Anda perlu menyesuaikan dukungan CORS di ESP.

Panduan cara kerja Endpoint lainnya

• Bermigrasi ke ESPv2

• Panduan cara kerja Cloud Endpoints Frameworks untuk lingkungan standar App Engine

• Panduan cara kerja Cloud Endpoints untuk gRPC