API Gateway：Gunakan layanan backend untuk membuat dan mengelola API

Ikhtisar

Untuk membantu Anda mengelola sejumlah API yang terus bertambah secara efisien, API Gateway mengabstraksi layanan backend sebagai sumber daya dalam wilayah. Di konsol API Gateway, Anda dapat membuat layanan backend dan menentukan URL berbeda untuk layanan tersebut di lingkungan yang berbeda. Kemudian, Anda dapat memilih layanan backend saat membuat API yang menggunakan layanan tersebut. Dengan cara ini, permintaan untuk memanggil API diarahkan ke URL yang sesuai dari layanan backend berdasarkan lingkungan tempat API dipublikasikan. Anda juga dapat mengelola semua API yang telah dipublikasikan yang menggunakan layanan backend yang sama secara terpusat pada halaman konfigurasi layanan backend. Contoh skenario berikut didukung:

Skenario 1: Setelah Anda mengubah URL layanan backend di lingkungan pengujian, semua API yang telah dipublikasikan yang menggunakan layanan backend di lingkungan pengujian diperbarui secara otomatis tanpa perlu Anda mempublikasikan ulang API tersebut. Permintaan untuk memanggil API tersebut kemudian diarahkan ke URL baru layanan backend di lingkungan pengujian.

Skenario 2: Setelah Anda menghapus URL yang tidak lagi diperlukan untuk layanan backend di lingkungan pengujian, semua API yang telah dipublikasikan yang menggunakan layanan backend di lingkungan pengujian akan dicabut publikasinya.

Untuk informasi lebih lanjut, lihat bagian-bagian berikut.

Langkah-langkah

1. Buat layanan backend.

2. Tentukan URL berbeda untuk layanan backend di lingkungan yang berbeda.

3. Buat API.

4. Buat aplikasi dan otorisasi untuk memanggil API.

5. Debug API.

6. Kelola semua API yang telah dipublikasikan yang menggunakan layanan backend di lingkungan tertentu.

Langkah 1: Buat layanan backend

1. Masuk ke konsol API Gateway. Di panel navigasi di sebelah kiri, pilih Manage APIs > Backend Services. Halaman Layanan Backend muncul.

2. Di pojok kanan atas halaman, klik Create Backend Service untuk membuat layanan backend. Dalam contoh ini, parameter Tipe disetel ke HTTP/HTTPS. Anda tidak dapat membuat layanan backend tipe HTTP/HTTPS atau OSS di wilayah Hong Kong, Cina, dan wilayah lainnya di luar daratan Cina.

   • Anda harus memilih tipe untuk setiap layanan backend yang ingin Anda buat. Anda tidak dapat mengubah tipe setelah layanan backend dibuat, tetapi Anda dapat mengubah nama dan deskripsi layanan backend.

   • Tipe berikut didukung: Layanan HTTP/HTTPS, VPC, Function Compute, OSS, EventBridge, Penemuan Layanan, Campuran, dan MOCK.

Langkah 2: Tentukan URL berbeda untuk layanan backend di lingkungan yang berbeda

1. Temukan layanan backend yang telah dibuat di halaman Layanan Backend dan klik Configure Backend Service and View Associated APIs di kolom Actions. Halaman Definisi Layanan Backend muncul. Halaman ini menyediakan empat tab, yaitu Draft, Test, Pre, dan Production. Anda dapat melihat semua API yang menggunakan layanan backend di tab Draf. Anda dapat menentukan URL untuk layanan backend di lingkungan masing-masing pada tab Uji, Pre, dan Produksi. Anda juga dapat melihat API yang telah dipublikasikan yang menggunakan layanan backend di lingkungan tertentu pada tab yang sesuai.

2. Pilih tab berdasarkan kebutuhan bisnis Anda, lalu klik Create di pojok kanan atas. Dalam contoh ini, Uji dipilih.

3. Tentukan URL untuk layanan backend untuk lingkungan yang dipilih. Lalu, klik Publikasikan. Saat pesan yang menunjukkan bahwa layanan telah dipublikasikan muncul, Anda dapat melanjutkan untuk membuat API.

4. Catat item berikut saat Anda menentukan URL:

   Catatan

   • Jika Anda menggunakan layanan backend HTTP atau HTTPS, Anda hanya perlu memasukkan URL layanan backend.

   • Jika Anda menggunakan sumber daya di virtual private cloud (VPC) sebagai layanan backend, Anda harus memilih aturan otorisasi yang Anda buat saat mengotorisasi API Gateway untuk mengakses VPC. Pilih Gunakan HTTPS jika diperlukan. Jika Anda memilih Gunakan HTTPS, protokol HTTPS digunakan untuk meminta layanan backend.

   • Jika Anda menggunakan Function Compute sebagai layanan backend, Anda harus menentukan apakah akan memilih Fungsi Acara atau Fungsi HTTP untuk parameter Jenis Fungsi. Jika Anda memilih Fungsi Acara, konfigurasikan parameter sesuai kebutuhan. Jika Anda memilih Fungsi HTTP, tentukan jalur pemicu.

   • Jika Anda menggunakan OSS sebagai layanan backend, Anda harus mengotorisasi API Gateway untuk mengakses objek di Bucket OSS Anda. Untuk memberikan izin baca kepada API Gateway, Anda harus mengizinkan API Gateway untuk memanggil operasi oss:GetObject pada Bucket OSS. Untuk memberikan izin tulis kepada API Gateway, Anda harus mengizinkan API Gateway untuk memanggil operasi oss:PutObject dan oss:DeleteObject pada Bucket OSS. Untuk mencabut izin yang diberikan kepada API Gateway, Anda dapat menghapus kebijakan otorisasi terkait secara manual dari Bucket OSS.

Langkah 3: Buat API

1. Di panel navigasi di sebelah kiri, pilih Kelola API > API. Di halaman APIs, klik Create API di pojok kanan atas. Halaman Buat API muncul.

2. Di langkah Informasi Dasar, konfigurasikan informasi dasar tentang API yang akan dibuat, termasuk grup tempat API milik, serta nama, metode autentikasi, tipe, dan deskripsi API. Pilih grup, konfigurasikan parameter lainnya, lalu klik Berikutnya. Aktifkan Otentikasi AppCode (Header & Query) dipilih untuk parameter Otentikasi AppCode dalam contoh ini.

3. Di langkah Definisikan Permintaan API, tentukan bagaimana klien, seperti browser, aplikasi seluler, atau sistem bisnis, mengirim permintaan untuk API. Konfigurasikan parameter Jenis Permintaan, Protokol, Jalur Permintaan, Metode HTTP, dan Mode Permintaan serta tambahkan parameter di bagian Parameter Permintaan. Lalu, klik Berikutnya. Dalam contoh ini, atur parameter Metode HTTP ke GET dan parameter Mode Permintaan ke Lewati. Nilai Lewati menunjukkan bahwa API Gateway meneruskan parameter yang diterima ke layanan backend tanpa memetakan parameter tersebut.

4. Di langkah Definisikan Layanan Backend, konfigurasikan tipe dan URL layanan backend ke mana API Gateway mengirim permintaan yang diterima dari klien dan bagaimana parameter dipetakan dan diproses. Contoh berikut menjelaskan cara menggunakan layanan backend yang ada. Pilih Gunakan Layanan Backend yang Ada untuk parameter Mode Konfigurasi dan Layanan HTTP/HTTPS untuk parameter Tipe Layanan Backend. Konsol secara otomatis mencari layanan backend dengan tipe yang dipilih. Pilih testHttp yang Anda buat dari daftar drop-down Layanan Backend. Untuk melihat URL layanan backend di lingkungan yang berbeda, arahkan pointer ke Lihat Konfigurasi Lingkungan dan klik tab yang sesuai. Setelah Anda memilih layanan backend, konfigurasikan parameter lainnya yang muncul berdasarkan tipe layanan backend. Untuk membuat API yang menggunakan layanan backend HTTP atau HTTPS, Anda harus mengatur parameter Jalur Permintaan Backend, Metode HTTP, dan Periode Timeout Layanan Backend.

5. Di langkah Definisikan Respon, konfigurasikan informasi respon untuk menghasilkan dokumentasi API. Dokumentasi ini membantu pemanggil API lebih memahami API. Anda dapat mengonfigurasi parameter Response ContentType, Contoh Respon, dan Contoh Respon Kesalahan. Dalam contoh ini, langkah ini dilewati. Klik Buat.

6. Setelah Anda klik Buat, pesan muncul untuk memberi tahu Anda untuk mempublikasikan API. API Gateway menyediakan tiga lingkungan tempat Anda dapat mempublikasikan API: Produksi, Pre, dan Uji. Semua konfigurasi yang Anda lakukan pada API hanya dapat berlaku setelah Anda mempublikasikan API ke lingkungan yang diperlukan.

   Penting

   Sebelum Anda mempublikasikan API yang menggunakan layanan backend ke lingkungan, pastikan bahwa layanan backend didefinisikan di lingkungan tersebut. Jika tidak, Anda tidak dapat mempublikasikan API.

Langkah 4: Buat aplikasi dan otorisasikan untuk memanggil API

1. Aplikasi adalah identitas yang Anda gunakan untuk memanggil API. Di langkah sebelumnya untuk membuat API, parameter Otentikasi Keamanan disetel ke Alibaba Cloud App. Setelah Anda mempublikasikan API, Anda harus membuat aplikasi dan memberikan izin kepada aplikasi untuk memanggil API.

2. Di panel navigasi di sebelah kiri, pilih Panggil API > Apps. Dua mode otentikasi disediakan untuk metode otentikasi keamanan Alibaba Cloud App: pasangan AppKey dan AppSecret dan AppCode. Dalam contoh ini, mode AppCode digunakan untuk mengotentikasi APP. Untuk informasi lebih lanjut tentang mode ini, lihat Panggil API dalam mode otentikasi sederhana.

3. Di daftar API, temukan API yang telah dibuat dan klik Authorize di kolom Tindakan. Atur parameter Stage ke lingkungan tempat Anda mempublikasikan API. Masukkan nama aplikasi yang Anda buat di kotak pencarian di sebelah kanan parameter Pilih Aplikasi untuk Otorisasi. Di hasil pencarian, pilih aplikasi yang Anda buat, klik Add di kolom Tindakan, lalu klik Confirm. Pesan muncul untuk memberi tahu Anda bahwa aplikasi telah diotorisasi untuk memanggil API.

Langkah 5: Debug API

Debug API setelah otorisasi berhasil. API Gateway mendukung debugging online. Kami sarankan Anda menggunakan fitur ini untuk memeriksa apakah API dikonfigurasi dengan benar sebelum Anda memanggil API di klien.

Di halaman API, klik nama API yang telah dibuat, dan klik Debug API di kolom Tindakan. Di halaman detail API, klik Debug API di pohon navigasi di sebelah kiri. Jika Anda telah menentukan parameter permintaan untuk API, Anda dapat memasukkan nilai berbeda untuk parameter permintaan untuk memeriksa apakah API dikonfigurasi dengan benar. Saat Anda melakukan debug API, pastikan bahwa parameter Nama Aplikasi disetel ke aplikasi yang diotorisasi. Lingkungan untuk debugging harus menjadi lingkungan tempat aplikasi diotorisasi untuk memanggil API. Jika tidak, debugging mungkin gagal.

Langkah 6: Kelola semua API yang telah dipublikasikan yang menggunakan layanan backend di lingkungan tertentu

1. Saat Anda memodifikasi definisi layanan backend di lingkungan, semua API yang telah dipublikasikan yang menggunakan layanan backend di lingkungan tersebut diterbitkan ulang dan diperbarui secara batch.

2. Dalam contoh ini, URL dimodifikasi untuk testHttp di lingkungan uji. Pesan yang menunjukkan bahwa lingkungan memiliki API yang telah dipublikasikan dan bahwa modifikasi akan disinkronkan ke semua API muncul. Setelah layanan backend diterbitkan ulang, hasil penerbitan API ditampilkan dalam daftar. Saat Anda memanggil API yang menggunakan layanan backend di lingkungan uji, permintaan diteruskan ke URL baru.

3. Jika URL layanan backend tidak lagi diperlukan di lingkungan, Anda dapat menghapus layanan backend dari lingkungan tersebut. API yang telah dipublikasikan yang menggunakan layanan backend di lingkungan yang sama dihapus secara sinkron.

   Peringatan

   Operasi di atas dilakukan pada semua API terkait dan tidak dapat dibatalkan. Lanjutkan dengan hati-hati.