API Gateway：Buat API

Langkah 1: Konfigurasi API

Masuk ke konsol API Gateway. Di panel navigasi sebelah kiri, pilih Kelola API > API. Pada halaman API, klik Buat API untuk membuat dan mengonfigurasi API.

1. Konfigurasikan Informasi Dasar

   Parameter	Deskripsi
   Grup API	Unit manajemen dasar API. Sebelum Anda membuat API, Anda harus membuat grup API. Saat Anda memilih grup, wilayah dipilih untuk API tersebut.
   Nama API	Nama API yang akan dibuat. Setiap nama API dalam grup API harus unik.
   Otentikasi Keamanan	Saat ini, Alibaba Cloud App dan Tanpa Otentikasi didukung. Alibaba Cloud App: memungkinkan pemanggil menggunakan aplikasi yang lolos otentikasi untuk memanggil API. Tanpa Otentikasi: memungkinkan semua pengguna yang mengetahui definisi permintaan API untuk mengirimkan permintaan. API Gateway langsung meneruskan permintaan ke layanan backend tanpa memverifikasi identitas pemanggil. Kami menyarankan Anda untuk tidak menyetel Sertifikasi Keamanan ke Tanpa Otentikasi.
   Algoritma Tanda Tangan	Algoritma yang digunakan untuk menandatangani permintaan API. Nilai valid: HMAC_SHA256 HMAC_SHA1 dan HMAC_SHA256: Jika Anda menyetel parameter ke nilai ini, kedua algoritma tersebut didukung.
   Opsi API	Fitur yang ingin Anda berikan kepada API. Nilai valid: Perlindungan Anti-Replay (Header X-Ca-Nonce Diperlukan) Larang Akses Internet Izinkan Publikasi API ke Alibaba Cloud Marketplace Catatan Jika Anda memilih Larang Akses Internet dan ingin mengajukan nama domain VPC, klik Ajukan nama domain VPC untuk pergi ke konsol.
   Deskripsi	Deskripsi API.

2. Konfigurasikan Informasi Permintaan

   Pada langkah Definisikan Permintaan API, konfigurasikan informasi permintaan tentang API. Konfigurasi mencakup Protokol, Jalur Permintaan, Metode HTTP, Mode Permintaan, dan Parameter Permintaan.

   Parameter	Deskripsi
   Protokol	Protokol jaringan yang digunakan untuk permintaan API. Nilai valid: HTTP dan HTTPS.
   Jalur Permintaan	Jalur permintaan API yang sesuai dengan host layanan. Jalur permintaan bisa berbeda dari jalur layanan backend aktual. Anda harus menentukan jalur yang valid dan semantik akurat sebagai jalur permintaan. Anda dapat mengonfigurasi parameter dinamis dalam jalur permintaan. Ini memerlukan Anda menentukan parameter jalur dalam permintaan. Selain itu, parameter jalur dapat dipetakan ke parameter query dan header yang diterima oleh layanan backend.
   Metode HTTP	Metode permintaan HTTP standar. Nilai valid: PUT, GET, POST, DELETE, PATCH, HEAD, OPTIONS, dan ANY.
   Mode Permintaan	Mode di mana parameter permintaan dilewatkan. Nilai valid: Peta Parameter Permintaan (Filter Parameter Tidak Dikenal), Peta (Lewati Parameter Tidak Dikenal), dan Lewati. Peta (Filter Parameter Tidak Dikenal): menentukan bahwa Anda harus mengonfigurasi pemetaan permintaan dan respons untuk parameter query, jalur, dan formulir body. API Gateway hanya meneruskan parameter yang dikonfigurasi secara transparan ke layanan backend. Parameter lainnya difilter. Peta (Lewati Parameter Tidak Dikenal): menentukan bahwa Anda harus mengonfigurasi pemetaan permintaan dan respons untuk parameter query, jalur, dan formulir body. API Gateway hanya memetakan dan memverifikasi parameter permintaan yang dikonfigurasi dan meneruskan parameter tidak dikenal secara transparan ke layanan backend. Lewati: menentukan bahwa Anda tidak perlu mengonfigurasi parameter query dan formulir body dalam permintaan. Namun, Anda harus mengonfigurasi parameter jalur. API Gateway meneruskan semua parameter yang dikirim dari klien ke layanan backend secara transparan.

   Konfigurasikan Parameter Permintaan: Pada bagian Parameter Permintaan, konfigurasikan parameter permintaan API di lokasi tertentu. Lokasi yang didukung meliputi Jalur Parameter, Head, dan Query. Saat mengonfigurasi parameter jalur dinamis, berikan deskripsi untuk parameter tersebut. Jenis data yang didukung meliputi String, Int, dan Boolean.

   • Nama semua parameter harus unik.

   • Gunakan tombol pintasan di kolom No. untuk mengubah urutan parameter.

   • Klik Hapus di kolom Tindakan untuk menghapus parameter yang tidak diperlukan.

   Catatan

   Jika Anda telah mengonfigurasi parameter dinamis dalam jalur permintaan, definisikan parameter dengan nama yang sama dan atur Lokasi Parameter ke Jalur Parameter.

   Konfigurasikan Aturan Verifikasi Parameter: Temukan parameter yang ingin diverifikasi dan klik Pengaturan Lanjutan di kolom Tindakan. Dalam kotak dialog Pengaturan Lanjutan, konfigurasikan parameter terkait seperti Panjang Maksimum dan Nilai Enumerasi. API Gateway akan memverifikasi permintaan berdasarkan aturan ini. Permintaan dengan parameter tidak valid tidak dikirim ke layanan backend Anda, sehingga mengurangi beban kerja pada layanan backend.

3. Konfigurasikan Layanan Backend

   Pada langkah Definisikan Layanan Backend, konfigurasikan pemetaan permintaan dan respons untuk parameter serta tentukan konfigurasi API layanan backend Anda. Setelah API Gateway menerima permintaan, ia mengubah format permintaan sesuai dengan konfigurasi layanan backend dan meneruskan permintaan ke layanan backend Anda.

   Configure basic information: Pada bagian Pengaturan Dasar untuk Layanan Backend, konfigurasikan informasi dasar tentang layanan backend.

   Parameter	Deskripsi
   Mode Konfigurasi	Menentukan apakah Anda ingin menggunakan layanan backend yang ada atau menyesuaikan layanan backend. Nilai valid: Gunakan Layanan Backend yang Ada Sesuaikan Layanan Backend
   Tipe Layanan Backend	Tipe layanan backend. Nilai valid: Layanan HTTP/HTTPS, VPC, Function Compute, OSS, dan Mock. HTTP/HTTPS: Opsi ini dipilih secara default. Ini menunjukkan bahwa API Gateway mengakses layanan backend melalui HTTP atau HTTPS. Jika API Gateway dapat berkomunikasi langsung dengan layanan backend, pilih opsi ini. Jika Anda ingin menggunakan layanan HTTPS sebagai layanan backend, Anda harus mengonfigurasi sertifikat SSL untuk layanan HTTPS. Function Compute: Jika Anda ingin menggunakan Function Compute sebagai layanan backend, lakukan operasi berikut terlebih dahulu: Buat fungsi di Konsol Function Compute, tentukan nama layanan dan nama fungsi, lalu peroleh Nama Sumber Daya Alibaba Cloud (ARN) untuk peran Function Compute. VPC: Jika layanan backend diterapkan di virtual private cloud (VPC), pilih opsi ini. OSS: Jika Object Storage Service (OSS) adalah layanan backend, pilih opsi ini. Mock: Jika Anda ingin mensimulasikan hasil yang diharapkan dari layanan backend HTTP atau HTTPS, pilih opsi ini. Catatan Anda tidak dapat membuat layanan backend tipe HTTP atau OSS di wilayah di luar China atau di wilayah China (Hong Kong).
   Nama Akses VPC	Jika layanan backend Anda diterapkan di VPC, tentukan nama otorisasi akses VPC.
   URL Layanan Backend	URL host layanan backend. Nilai dapat berupa nama domain atau nilai dalam format http://host:port atau https://host:port. Nilai harus dimulai dengan http:// atau https://.
   Jalur Permintaan Backend	Jalur permintaan aktual API Anda pada server backend Anda. Jika Anda ingin menerima parameter dinamis dalam jalur layanan backend, Anda harus mendeklarasikan pemetaan parameter dengan menentukan lokasi dan nama parameter permintaan terkait.
   Metode HTTP	Metode permintaan HTTP standar. Nilai valid: PUT, GET, POST, DELETE, PATCH, HEAD, OPTIONS, dan ANY.
   Periode Waktu Habis Layanan Backend	Waktu yang diizinkan untuk API Gateway mengirim permintaan API yang diterima ke layanan backend dan menerima respons dari layanan backend. Waktu respons dimulai dari saat API Gateway mengirim permintaan API ke layanan backend dan berakhir saat API Gateway menerima respons dari layanan backend. Waktu respons tidak boleh melebihi 30 detik. Jika API Gateway tidak menerima respons dari layanan backend dalam waktu 30 detik, API Gateway berhenti mengakses layanan backend dan mengembalikan pesan kesalahan.

   Konfigurasikan Parameter Layanan Backend: Pada bagian Parameter Layanan Backend, konfigurasikan pemetaan permintaan dan respons untuk parameter. API Gateway mendukung pemetaan nama dan lokasi. Anda dapat memetakan parameter permintaan jalur, header, query, atau body ke parameter respons di lokasi berbeda, sehingga mengemas layanan backend Anda ke dalam bentuk API yang distandardisasi dan profesional.

   Configure constant parameters: Pada bagian Parameter Konstan, konfigurasikan parameter konstan. Parameter konstan tidak terlihat oleh pengguna Anda. Setelah API Gateway menerima permintaan, ia menambahkan parameter konstan ke lokasi yang ditentukan dan meneruskan permintaan ke layanan backend Anda untuk memenuhi kebutuhan bisnis Anda.

   Konfigurasikan Parameter Sistem: Pada bagian Parameter Sistem, konfigurasikan parameter sistem yang didukung oleh API Gateway. Secara default, API Gateway tidak menambahkan parameter sistem ke permintaan API. Jika Anda ingin memperoleh parameter sistem, konfigurasikan lokasi dan nama mereka. Tabel berikut mencantumkan parameter sistem:

   Parameter	Deskripsi
   CaClientIp	Alamat IP klien yang mengirim permintaan API. Jika Anda telah mengonfigurasi Web Application Firewall (WAF) atau Content Delivery Network (CDN), sistem mencatat alamat IP sumber. Alamat IP asli klien dicatat di X-Forwarded-For.
   CaDomain	Nama domain yang digunakan untuk mengirim permintaan API.
   CaRequestHandleTime	Waktu permintaan dalam UTC.
   CaRequestId	ID permintaan (RequestId).
   CaApiName	Nama API.
   CaHttpSchema	Protokol yang digunakan untuk memanggil API. Nilai valid: HTTP dan HTTPS.
   CaProxy	Proxy yang digunakan untuk menangani permintaan API. Tetapkan nilainya ke AliCloudApiGateway.
   CaClientUa	User agent klien yang mengirim permintaan API.
   CaCloudMarketInstanceId	ID instance yang sesuai dengan komoditas Alibaba Cloud Marketplace yang dibeli untuk pertama kali.
   CaAppId	ID aplikasi yang digunakan untuk memanggil API.
   CaAppKey	Kunci aplikasi yang digunakan untuk memanggil API.
   CaAppExtendInfo	Ekstensi aplikasi.
   CaStage	Lingkungan tempat Anda memanggil API. Nilai valid: RELEASE, TEST, dan PRE.
   CaInstanceId	ID instance tempat API milik.
   CaSourceVpcId	VPC tempat alamat IP klien milik.

   Anda dapat memilih Lewati Header Host di bagian Pengaturan Pass-through Header Permintaan halaman detail grup API. Setelah memilih Lewati Header Host, API Gateway meneruskan parameter header Host dalam permintaan ke layanan backend. Jika tidak memilih, API Gateway mengirimkan header Host yang Anda tentukan ke layanan backend. Contoh berikut menunjukkan perbedaan nama host yang diterima oleh layanan backend sebelum dan sesudah Lewati Header Host diaktifkan.

   Misalnya, jika Anda melampirkan nama host xuemeng.XXXX.com ke grup API, nama host layanan backend API dalam grup API adalah apigatewayXXXXXXalicloudapi.com:8080. Potongan kode berikut menunjukkan nama host berbeda yang diterima oleh layanan backend Anda.

   Jika Lewati Header Host diaktifkan, nama host berikut diterima:

Host: xuemeng.XXXX.com

Jika Lewati Header Host dinonaktifkan, nama host berikut diterima:

Host: apigatewayXXXXXXalicloudapi.com:8080

4. Konfigurasikan Informasi Respons

   Pada langkah Definisikan Respons, konfigurasikan Response ContentType, Contoh Respons, Contoh Respons Kesalahan, dan Kode Kesalahan.

Langkah 2: Debug API

Setelah membuat dan mengonfigurasi API, Anda dapat men-debug API di halaman debugging API untuk memastikan bahwa API berfungsi seperti yang diharapkan.

Setelah API dibuat dan dikonfigurasi, Anda dialihkan ke halaman API. Di halaman ini, lakukan operasi berikut untuk memeriksa apakah API dapat dipanggil dan apakah URL permintaan valid:

1. Temukan API yang Anda buat, dan klik nama API atau klik Kelola di kolom Tindakan untuk pergi ke halaman Definisi.

2. Di panel navigasi sebelah kiri, klik Debug API.

3. Di halaman yang muncul, tentukan parameter permintaan di bagian Parameter Permintaan dan klik Kirim Permintaan.

Hasil muncul di sisi kanan halaman.

Jika respons sukses dikembalikan, API dipanggil seperti yang diharapkan.

Jika kode status HTTP 4XX atau 5XX dikembalikan, kesalahan terjadi saat API dipanggil. Untuk informasi lebih lanjut, lihat Cara memperoleh pesan kesalahan dan Kode kesalahan.

Langkah 3: Langkah selanjutnya

Setelah mengonfigurasi dan men-debug API, API tersedia untuk panggilan. Anda dapat menerbitkan API ke lingkungan uji, staging, atau produksi untuk debugging lebih lanjut atau untuk pengguna memanggilnya. Anda juga dapat menambahkan konfigurasi keamanan ke API, misalnya melampirkan tanda tangan untuk API. Untuk informasi lebih lanjut, lihat Gunakan otentikasi digest untuk memanggil API.