Topik ini menjelaskan cara membuat dan menerbitkan API dengan EventBridge sebagai layanan backend di API Gateway. Topik ini juga mencakup cara memanggil API menggunakan metode otentikasi Alibaba Cloud App dan menggunakan AppCode aplikasi untuk otentikasi.
Ikhtisar
Untuk membuat dan menerbitkan API dengan EventBridge sebagai layanan backend, Anda harus mengikuti langkah-langkah berikut secara berurutan:
Buat layanan backend.
Buat grup API.
Buat API.
Buat aplikasi dan berikan izin kepada aplikasi untuk memanggil API.
Debug API.
Panggil API.
Prasyarat
Layanan EventBridge telah diaktifkan, dan bus acara kustom telah dibuat. Untuk informasi lebih lanjut, lihat Kelola bus acara kustom.
Langkah 1: Buat layanan backend
Masuk ke Konsol API Gateway. Di panel navigasi kiri, pilih Manage APIs > Backend Services.
Di pojok kanan atas halaman, klik Create Backend Service. Dalam kotak dialog yang muncul, masukkan nama layanan backend, atur Tipe ke EventBridge, lalu klik Confirm.
Di halaman Layanan Backend, temukan layanan backend yang Anda buat dan pilih Configure Backend Service and View Associated APIs di kolom Aksi.
Klik tab Produksi dan klik Buat di pojok kanan atas bagian Informasi Dasar untuk mengonfigurasi layanan backend di lingkungan Produksi. Anda harus mengonfigurasi layanan backend di lingkungan Produksi sebelum dapat menerbitkan API ke lingkungan tersebut.
Di halaman Definisikan Layanan Backend, pilih bus acara yang Anda buat di konsol EventBridge.
Jika bus acara yang Anda pilih dan instance API Gateway berada di wilayah yang sama, API Gateway akan mendorong sebuah acara ke bus acara Anda ketika Anda memanggil API menggunakan jaringan internal. Dalam contoh ini, baik bus acara maupun instance API Gateway berada di wilayah China (Hangzhou). Setelah menetapkan parameter, klik Terbitkan.
Langkah 2: Buat grup API
API dikelola dalam grup API. Anda harus membuat grup API sebelum membuat API.
Di panel navigasi kiri Konsol API Gateway, pilih Manage APIs > API Groups. Di pojok kanan atas halaman, klik Create Group. Dalam kotak dialog yang muncul, pilih instance, masukkan nama grup, dan tetapkan jalur dasar. Grup API harus berada di same region dengan bus acara yang Anda gunakan.
Setelah membuat grup API, grup tersebut akan muncul di halaman API Groups. Anda dapat mengklik nama grup untuk pergi ke halaman Detail Grup. Di halaman ini, Anda dapat mengikat nama domain, memodifikasi informasi dasar, dan mengubah tipe instance.
API Gateway secara otomatis memberikan public second-level domain name ke grup API. Nama domain ini hanya untuk tujuan debugging dan pengujian. Jika Anda menggunakan nama domain ini untuk melakukan panggilan API, Anda dapat melakukan 100 panggilan per hari di wilayah di luar daratan Tiongkok dan 1,000 panggilan per hari di wilayah di daratan Tiongkok. Kami menyarankan Anda untuk mengikat an independent domain name setelah membuat grup API. Dalam contoh ini, nama domain tingkat dua default digunakan.
Langkah 3: Buat API
Di panel navigasi kiri Konsol API Gateway, pilih Manage APIs-APIs. Di pojok kanan atas halaman, klik Create API.
Konfigurasikan informasi dasar untuk API.
Dalam langkah ini, konfigurasikan informasi dasar untuk API yang akan dibuat, termasuk grup API tempat API tersebut milik dan nama, metode otentikasi, tipe, serta deskripsi API. Dalam contoh ini, parameter Group diatur ke grup API yang telah dibuat dan parameter Otentikasi AppCode diatur ke Enable AppCode Authentication (Header & Query). Atur parameter lain sesuai kebutuhan dan klik Berikutnya.
Konfigurasikan informasi permintaan untuk API.
Dalam langkah ini, tentukan bagaimana klien, seperti browser, aplikasi seluler, atau sistem bisnis, mengirim permintaan untuk API. Parameter yang perlu Anda tentukan meliputi Tipe Permintaan, Protokol, Jalur Permintaan, Metode HTTP, Mode Permintaan, dan parameter di bagian Parameter Permintaan. Lalu, klik Berikutnya. Dalam contoh ini, parameter Mode Permintaan diatur ke Pass-through. Opsi ini menunjukkan bahwa API Gateway langsung meneruskan permintaan API ke EventBridge tanpa memproses permintaan tersebut.
Konfigurasikan informasi layanan backend untuk API.
Dalam langkah ini, konfigurasikan tipe dan URL layanan backend ke mana API Gateway mengirim permintaan yang diterima dari klien dan bagaimana parameter dipetakan dan diproses. Dalam contoh ini, Use Existing Backend Service dipilih untuk Mode Konfigurasi, EventBridge dipilih untuk Tipe Layanan Backend, dan layanan backend yang Anda buat dipilih dari daftar drop-down Layanan Backend. Klik Berikutnya.
Anda hanya dapat memilih layanan backend yang ada saat membuat API dengan EventBridge sebagai layanan backend. Anda tidak dapat menyesuaikan layanan backend.
Tentukan respons untuk API.
Dalam langkah ini, konfigurasikan informasi respons untuk menghasilkan dokumentasi API. Dokumentasi ini membantu pemanggil API lebih memahami API. Anda dapat mendefinisikan contoh respons sukses dan contoh respons gagal. Dalam contoh ini, langkah ini dilewati. Klik Create.
Terbitkan API.
Semua konfigurasi yang Anda lakukan pada API hanya dapat berlaku setelah Anda menerbitkan API ke lingkungan. Dalam contoh ini, layanan backend dikonfigurasi hanya di lingkungan Produksi. Oleh karena itu, Anda hanya dapat menerbitkan API ke lingkungan Produksi. Jika Anda ingin menerbitkan API ke lingkungan lain, Anda harus mengonfigurasi layanan backend di lingkungan tersebut terlebih dahulu. Klik Publish di pesan yang menunjukkan pembuatan API berhasil. Lalu ikuti petunjuk di layar untuk menerbitkan API ke lingkungan Produksi.
Langkah 4: Buat aplikasi dan berikan aplikasi izin untuk memanggil API
Aplikasi adalah identitas yang Anda gunakan untuk memanggil API. Dalam langkah sebelumnya untuk membuat API, parameter Otentikasi Keamanan diatur ke Alibaba Cloud App. Setelah Anda menerbitkan API, Anda harus membuat aplikasi dan memberikan aplikasi izin untuk memanggil API.
Buat aplikasi.
Di panel navigasi kiri Konsol API Gateway, pilih Call APIs-Apps untuk membuat aplikasi. Dua mode otentikasi disediakan untuk metode otentikasi keamanan Alibaba Cloud App: pasangan AppKey dan AppSecret serta AppCode. Dalam contoh ini, AppCode digunakan. Untuk informasi lebih lanjut tentang metode otentikasi keamanan Alibaba Cloud App, lihat Otorisasi API.
Berikan aplikasi izin untuk memanggil API.
Di halaman APIs, temukan API yang dibuat dan klik Authorize di kolom Aksi. Atur parameter Stage ke lingkungan tempat Anda telah menerbitkan API. Dalam contoh ini, parameter Stage diatur ke Produksi. Masukkan nama aplikasi yang Anda buat di kotak pencarian bagian Pilih Aplikasi untuk Otorisasi. Di hasil pencarian, pilih aplikasi yang dibuat, klik Tambah di kolom Aksi, lalu klik Konfirmasi. Pesan muncul untuk memberi tahu Anda bahwa aplikasi telah diotorisasi untuk memanggil API.
Langkah 5: Debug API
API Gateway mendukung debugging online. Kami menyarankan Anda menggunakan fitur ini untuk memeriksa apakah API dikonfigurasi dengan benar sebelum Anda memanggil API ini di klien.
Di halaman APIs, klik nama API yang dibuat. Di halaman detail API, klik Debug API di pohon navigasi kiri. Jika Anda mendefinisikan parameter permintaan untuk API, Anda dapat memasukkan nilai berbeda untuk parameter permintaan untuk memeriksa apakah API bekerja sesuai harapan.
Saat Anda melakukan debugging API, pastikan bahwa parameter Nama Aplikasi diatur ke aplikasi yang diotorisasi. Lingkungan untuk debugging harus menjadi lingkungan di mana aplikasi diizinkan untuk memanggil API. Jika tidak, debugging mungkin gagal. Dalam contoh ini, Produksi dipilih sebagai lingkungan untuk debugging.
Setelah debugging berhasil, Anda dapat memeriksa detail acara di bus acara Anda berdasarkan ID acara yang dikembalikan.
Langkah 6: Panggil API
Setelah Anda menyelesaikan langkah-langkah sebelumnya, Anda telah membuat API dan aplikasi, mengotorisasi aplikasi untuk memanggil API, men-debug API, dan menerbitkan API ke lingkungan Produksi. Dalam langkah ini, Anda dapat memanggil API di sistem bisnis Anda menggunakan AppCode aplikasi.
Untuk informasi lebih lanjut tentang cara memanggil API, lihat Panggil API dalam mode otentikasi sederhana.