API Gateway:Ikhtisar

1. Aturan penggunaan plugin

• Anda hanya dapat menyambungkan satu plugin dari tipe tertentu ke sebuah API.

• Plugin bersifat spesifik per wilayah. Anda hanya dapat menyambungkan plugin ke API yang berada di wilayah yang sama. Setiap pengguna dapat membuat maksimal 1.000 plugin per wilayah.

• Kebijakan plugin dan API dikelola secara terpisah. Kebijakan plugin hanya berlaku pada API setelah Anda menyambungkan plugin tersebut ke API di lingkungan tertentu.

• API harus dipublikasikan terlebih dahulu sebelum Anda dapat menyambungkan plugin ke lingkungan yang sesuai.

• Menyambungkan, melepas, atau memperbarui plugin langsung berlaku tanpa perlu menerbitkan ulang API. Untuk API berisiko tinggi, uji plugin terlebih dahulu pada API non-produksi.

• Mengambil API offline tidak melepas plugin-nya. Plugin akan secara otomatis disambungkan kembali saat API diterbitkan ulang.

• Anda tidak dapat menghapus plugin jika plugin tersebut masih terikat pada API yang sedang dipublikasikan atau pernah dipublikasikan dan belum dihapus.

2. Plugin yang didukung

API Gateway mendukung plugin berikut. Plugin dieksekusi sesuai urutan yang tercantum di bawah ini. Untuk detail konfigurasi, klik nama plugin.

• CORS

• Basic auth plugin

• JWT authentication plugin

• Third-party authentication plugin

• IP-based access control

• Traffic control

• Parameter-based access control

• Caching

• Backend routing

• Circuit breaker

• Backend signature plugin

• Transformer plugin (for request transformation)

• Error code mapping

• Transformer plugin (for response transformation)

• Log masking plugin

3. Mulai cepat

• Buka Konsol plugin API Gateway.

• Klik Create Plugin. Pada halaman Create Plugin, pilih China (Hangzhou) untuk Region, masukkan nama plugin, misalnya test, lalu pilih tipe dari daftar drop-down Plugin Type. Opsi yang tersedia meliputi: traffic control, IP-based access control, backend signature, JWT authentication, basic auth, CORS, caching, backend routing, parameter-based access control, error code mapping, circuit breaker (hanya untuk dedicated instance), third-party authentication (hanya untuk dedicated instance), log masking (hanya untuk dedicated instance), dan Transformer (hanya untuk dedicated instance). Setelah memilih tipe plugin, templat konfigurasi YAML akan muncul di bagian Script Configuration. Sebagai contoh, konfigurasi dasar untuk traffic control mencakup parameter seperti unit, apiDefault, userDefault, appDefault, dan specials. Sesuaikan konfigurasi sesuai kebutuhan.

• Di Konsol plugin, sambungkan plugin ke API yang telah dipublikasikan.

Pada kotak dialog Bind API, pilih grup API dan lingkungan target, lalu klik Search untuk menemukan API. Klik + Add untuk menambahkan API ke daftar yang dipilih, kemudian klik OK untuk menyelesaikan pengikatan. Tindakan ini akan menimpa plugin jenis yang sama yang sebelumnya sudah terikat pada API tersebut.

• Plugin langsung berlaku setelah Anda menyambungkannya.

4. Referensi OpenAPI

Anda dapat memanggil operasi API berikut untuk mengelola plugin:

• CreatePlugin: Membuat plugin.

• ModifyPlugin: Memodifikasi plugin.

• DeletePlugin: Menghapus plugin.

• DescribePlugins: Menanyakan plugin.

• AttachPlugin: Menyambungkan plugin ke API.

• DetachPlugin: Melepas plugin dari API.

• DescribePluginApis: Menanyakan API yang terikat dengan plugin.

• DescribePluginsByApi: Menanyakan plugin yang terikat pada API.

5. Batasan

• Metadata satu plugin tidak boleh melebihi 50 KB.

• Setiap pengguna dapat membuat maksimal 1.000 plugin di setiap wilayah.

• Fitur debugging API di Konsol saat ini tidak mendukung plugin JWT authentication. Sebagai gantinya, gunakan Postman atau perintah curl untuk debugging.