Berdasarkan protokol WebSocket, API WebSocket memungkinkan komunikasi dua arah antara klien dan server. Ini merupakan solusi ideal untuk membangun aplikasi real-time seperti aplikasi obrolan, notifikasi real-time, dan game. Topik ini menjelaskan cara membuat API WebSocket di konsol.
Skenario
Cloud-native API Gateway menyediakan dua metode untuk membuat API: di dalam instance atau di luar instance. Metode-metode ini cocok untuk skenario berikut:
Buat API di dalam instance
Manajemen sumber daya khusus: API digunakan hanya di dalam instance tertentu untuk mengelola sumber daya spesifik atau logika internal.
Keamanan dan isolasi: Data atau fitur perlu diisolasi secara ketat untuk memastikan keamanan dan hanya dipanggil di dalam instance.
Konfigurasi layanan yang disederhanakan: Menyederhanakan konfigurasi dan pengelolaan API di dalam instance tertentu.
Buat API di luar instance
Berbagi lintas instance: Beberapa instance berbagi informasi definisi API.
Pengelolaan dan pemantauan terpusat: Kontrol izin terpadu, pencatatan, dan manajemen lalu lintas.
API yang dibuat di dalam instance Cloud-native API Gateway hanya dapat dilihat dan dikelola di dalam instance tersebut.
API yang dibuat di luar instance Cloud-native API Gateway tidak dapat dimodifikasi atau dihapus di dalam instance. Jika API dibuat di luar instance Cloud-native API Gateway, API tersebut hanya dapat dihapus dari daftar API eksternal.
Prosedur
Anda dapat membuat API baik di dalam maupun di luar instance:
Di luar instance
Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi kiri, pilih API, dan pilih wilayah di bilah menu atas.
Klik Create API, lalu klik Buat di kartu WebSocket API.
Di dalam instance
Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi kiri, pilih Instance, dan pilih wilayah di bilah menu atas.
Di halaman Instance, klik ID instance gateway target. Di panel navigasi kiri, pilih API, lalu klik Create API di pojok kanan atas.
Klik Create di kartu WebSocket API.
Di halaman Buat API WebSocket, masukkan API Name dan Description, serta pilih Resource Group target.
Parameter
Deskripsi
API Name
Tentukan nama untuk API yang ingin Anda buat. Nama API harus unik secara global.
Description
Masukkan deskripsi untuk API.
Resource Group
Pilih grup sumber daya target. Anda dapat mengklik Create Resource Group di sebelah kanan.