API Gateway：Publikasikan API

Prasyarat

API telah dibuat dan operasi telah ditambahkan. Untuk informasi lebih lanjut, lihat Buat REST API dan tambahkan operasi.

Prosedur

1. Masuk ke Konsol Cloud-native API Gateway.

2. API dapat dipublikasikan baik di dalam maupun di luar instance:

   API di dalam instance

   1. Di panel navigasi kiri, klik Cloud-native API Gateway > Instance. Di bilah navigasi atas, pilih wilayah.

   2. Di halaman Instance, klik ID instance target.

   3. Di panel navigasi di sebelah kiri, klik API, lalu klik REST API target Anda.

   API di luar instance

   1. Di panel navigasi kiri, klik Cloud-native API Gateway > API. Di bilah navigasi atas, pilih wilayah.

   2. Klik REST API target Anda.

3. Di halaman detail API, klik Publish API di pojok kanan atas.

   

4. Di panel Publikasikan REST API, konfigurasikan parameter yang diperlukan, lalu klik OK.

   • Parameter untuk API di dalam instance:

     Parameter	Deskripsi
     Instance	Instance gateway API cloud-native yang Anda buat. Gunakan instance yang berbeda untuk membedakan lingkungan bisnis, sehingga memungkinkan publikasi API multi-lingkungan.
     VPC	Jaringan virtual privat (VPC) tempat antarmuka instance tersebut berada.
     Publish Scope	Rentang publikasi antarmuka tingkat API. Pilih nama antarmuka untuk melihat detail titik akhir yang terpengaruh.
     Description	Masukkan deskripsi untuk operasi publikasi API.

   • Parameter untuk API di luar instance:

     Parameter	Deskripsi
     Domain Name	Pilih nama domain untuk mempublikasikan API. API yang dipublikasikan dapat diakses menggunakan nama domain tersebut. Jika tidak ada nama domain yang tersedia, klik Add Domain Name untuk membuat nama domain. Untuk informasi lebih lanjut, lihat Buat nama domain.
     Instance	Pilih instance gateway API cloud-native yang Anda buat untuk mempublikasikan. Gunakan instance yang berbeda untuk membedakan lingkungan bisnis, sehingga memungkinkan publikasi API multi-lingkungan.
     Scenarios	Pilih skenario untuk mempublikasikan API. Skenario terbagi menjadi dua kategori: skenario reguler dan skenario rilis canary. Nilai yang valid: Mock, Single Service, By Percentage (Multi-service), dan By Content (Multi-service). Skenario Reguler Mock: Dalam skenario Mock, respons mock yang dikonfigurasi dalam definisi operasi API dikembalikan untuk permintaan. Jika respons mock tidak dikonfigurasi, operasi API tidak dapat diakses. Catatan Jika Anda ingin mempublikasikan API ke skenario Mock, pastikan bahwa respons mock telah dikonfigurasi untuk setidaknya satu operasi dalam API. Jika tidak, API gagal dipublikasikan. Single Service: Dalam skenario ini, semua trafik diarahkan ke layanan backend tertentu. Ini adalah skenario yang paling umum. Skenario Rilis Canary By Percentage (Multi-service): Trafik diarahkan ke layanan backend yang dikonfigurasi berdasarkan bobot yang dikonfigurasi. Catatan Bobot dari semua layanan harus berjumlah 100. By Content (Multi-service): Trafik diarahkan ke layanan backend yang sesuai berdasarkan kondisi pencocokan. Jika Anda memilih Default di samping Kondisi Pencocokan, trafik diarahkan ke layanan backend yang dikonfigurasi ketika tidak ada aturan lain yang cocok. Tipe kondisi pencocokan berikut didukung: sama dengan, awalan, dan ekspresi reguler. Tipe parameter yang didukung: Query dan Header. Logika operasi "dan" digunakan antara beberapa kondisi pencocokan. Penting Anda hanya dapat memilih Default untuk satu entri. By Tag (Proportion-based Routing): Trafik diarahkan ke beberapa versi dari beberapa layanan backend berdasarkan konfigurasi proporsi. Pengarahan layanan tunggal direkomendasikan untuk rilis canary end-to-end demi performa yang lebih tinggi dan pengalaman yang lebih baik.
     Backend Services	Hubungkan layanan backend dengan instance. Jika tidak ada layanan backend yang tersedia, klik Create Service untuk membuat layanan. Untuk informasi lebih lanjut, lihat Buat layanan.
     Description	Masukkan deskripsi untuk API yang dipublikasikan.