Buat API dan tambahkan operasi - API Gateway - Alibaba Cloud Documentation Center

Cloud-native API Gateway mendukung pembuatan REST API baik di dalam maupun di luar instans, melalui konsol atau dengan mengimpor file OpenAPI. Setelah membuat API, Anda dapat menambahkan operasi untuk menentukan path dan metode permintaan.

Kasus penggunaan

API dapat dibuat di dalam atau di luar instans, tergantung pada kasus penggunaan Anda.

Buat API di dalam instans

Manajemen sumber daya khusus: API hanya mengelola sumber daya atau logika internal dalam instans tertentu.
Keamanan dan isolasi: Data atau fitur memerlukan isolasi ketat dan hanya dapat dipanggil dari dalam instans tersebut.
Konfigurasi layanan yang disederhanakan: Membatasi konfigurasi pada instans tertentu menyederhanakan manajemen API.

Buat API di luar instans

Akses bersama lintas-instans: Beberapa instans berbagi definisi API yang sama.
Manajemen dan pemantauan terpusat: Kontrol izin, pencatatan log, dan manajemen traffic yang terpadu.

Buat REST API di konsol

Cloud-native API Gateway menyediakan dua cara untuk membuat API di konsol: di dalam instans dan di luar instans.

Di luar instans

Masuk ke Cloud-native API Gateway console.
Di panel navigasi sebelah kiri, klik API. Di bilah menu atas, pilih wilayah.
Klik Create API.

Pada kartu REST API, klik Create. Di panel Create REST API, konfigurasikan parameter dan klik Confirm.

Parameter	Description
API Name	Masukkan nama untuk API. Nama harus unik secara global.
Base path	Path dasar untuk API. Saat client memanggil operasi tertentu, URL permintaan lengkapnya adalah `http(s)://{domain name}/{base path}/{operation path}`.
Version Management	Tentukan apakah akan mengaktifkan manajemen versi API. Versi API yang berbeda bersifat independen. Mereka menggunakan nama API yang sama tetapi dapat memiliki informasi dasar dan operasi yang berbeda. Untuk mengakses versi tertentu, sertakan identifikasi versinya dalam permintaan. Jika Anda mengaktifkan Version Management, Anda juga harus mengonfigurasi Usage. Catatan Jika Anda mengatur Usage ke Query, Anda harus mengonfigurasi parameter Add Query. Jika Anda mengatur Usage ke Header, Anda harus mengonfigurasi parameter Add Header.
Usage	Identifikasi versi dapat diteruskan melalui Path, parameter Query, atau Header. Path: Path permintaan lengkapnya adalah `/{base path}/{version_number}/{operation_path}`. Query: Path permintaan lengkapnya adalah `/{base path}/{operation_path}`. Permintaan harus menyertakan parameter query yang Anda tentukan di Add Query, dengan nilainya diatur ke nomor versi. Header: Path permintaan lengkapnya adalah `/{base path}/{operation_path}`. Permintaan harus menyertakan header yang Anda tentukan di Add Header, dengan nilainya diatur ke nomor versi.
Description	Masukkan deskripsi untuk API.
Resource Group	Pilih kelompok sumber daya target. Untuk membuat yang baru, klik Create Resource Group di sebelah kanan.

Klik Create API.

Pada kartu REST API, klik Create. Di panel Create REST API, konfigurasikan parameter dan klik Confirm.

Parameter	Description
API Name	Masukkan nama untuk API. Nama harus unik secara global.
Base path	Path dasar untuk API. Saat client memanggil operasi tertentu, URL permintaan lengkapnya adalah `http(s)://{domain name}/{base path}/{operation path}`.
Version Management	Tentukan apakah akan mengaktifkan manajemen versi API. Versi API yang berbeda bersifat independen. Mereka menggunakan nama API yang sama tetapi dapat memiliki informasi dasar dan operasi yang berbeda. Untuk mengakses versi tertentu, sertakan identifikasi versinya dalam permintaan. Jika Anda mengaktifkan Version Management, Anda juga harus mengonfigurasi parameter Usage. Catatan Jika Anda mengatur Usage ke Query, Anda harus mengonfigurasi parameter Add Query. Jika Anda mengatur Usage ke Header, Anda harus mengonfigurasi parameter Add Header.
Usage	Identifikasi versi dapat diteruskan melalui Path, parameter Query, atau Header. Path: Path permintaan lengkapnya adalah `/{base path}/{version_number}/{operation_path}`. Query: Path permintaan lengkapnya adalah `/{base path}/{operation_path}`. Permintaan harus menyertakan parameter query yang Anda tentukan di Add Query, dengan nilainya diatur ke nomor versi. Header: Path permintaan lengkapnya adalah `/{base path}/{operation_path}`. Permintaan harus menyertakan header yang Anda tentukan di Add Header, dengan nilainya diatur ke nomor versi.
Description	Masukkan deskripsi untuk API.
Resource Group	Pilih kelompok sumber daya target. Untuk membuat yang baru, klik Create Resource Group di sebelah kanan.

Di dalam instans

Masuk ke Cloud-native API Gateway console.
Di panel navigasi sebelah kiri, klik Instances. Di bilah menu atas, pilih wilayah.
Di halaman Instances, klik Instance ID target untuk membuka halaman Overview. Di panel navigasi sebelah kiri, klik API, lalu klik Create API.

Pada kartu REST API, klik Create. Di panel Create REST API, konfigurasikan parameter dan klik Confirm.

Parameter	Description
API Name	Masukkan nama untuk API. Nama harus unik secara global.
Domain Name	Pilih satu atau beberapa nama domain untuk API. Untuk membuat nama domain baru, klik Add Domain Name.
Base path	Path dasar untuk API. Saat client memanggil operasi tertentu, URL permintaan lengkapnya adalah `http(s)://{domain name}/{base path}/{operation path}`.
Version Management	Tentukan apakah akan mengaktifkan manajemen versi API. Versi API yang berbeda bersifat independen. Mereka menggunakan nama API yang sama tetapi dapat memiliki informasi dasar dan operasi yang berbeda. Untuk mengakses versi tertentu, sertakan identifikasi versinya dalam permintaan. Jika Anda mengaktifkan Version Management, Anda juga harus mengonfigurasi Usage. Catatan Jika Anda mengatur Usage ke Query, Anda harus mengonfigurasi parameter Add Query. Jika Anda mengatur Usage ke Header, Anda harus mengonfigurasi parameter Add Header.
Usage	Identifikasi versi dapat diteruskan melalui Path, parameter Query, atau Header. Path: Path permintaan lengkapnya adalah `/{base path}/{version_number}/{operation_path}`. Query: Path permintaan lengkapnya adalah `/{base path}/{operation_path}`. Permintaan harus menyertakan parameter query yang Anda tentukan di Add Query, dengan nilainya diatur ke nomor versi. Header: Path permintaan lengkapnya adalah `/{base path}/{operation_path}`. Permintaan harus menyertakan header yang Anda tentukan di Add Header, dengan nilainya diatur ke nomor versi.
Description	Masukkan deskripsi untuk API.
Resource Group	Pilih kelompok sumber daya target. Untuk membuat yang baru, klik Create Resource Group di sebelah kanan.
Scenario	Pilih skenario penggunaan untuk operasi ini. Skema dasar: Single Service. Skema rilis canary: By Percentage (Multi-service), By Content (Multi-service), dan By Tag (Proportion-based Routing). Catatan Jumlah persentase traffic untuk semua layanan target harus 100%.
Backend Services	Asosiasikan layanan backend dari gateway atau VPC saat ini. Jika belum ada layanan, klik Create Service untuk membuatnya. Penting Saat Anda membuat layanan baru, informasi port-nya mungkin tidak langsung muncul. Buka daftar drop-down Service Name dan klik Refresh. Informasi ini disinkronkan secara asinkron dan mungkin memerlukan waktu sejenak untuk muncul.

Buat REST API dengan mengimpor OpenAPI

Anda dapat mengimpor file OpenAPI untuk membuat API di dalam atau di luar instans.

Di luar instans

Masuk ke Cloud-native API Gateway console.
Di panel navigasi sebelah kiri, klik API. Di bilah menu atas, pilih wilayah.
Klik Create API.

Pada kartu REST API, klik Import. Di panel Create File based on OpenAPI, konfigurasikan parameter dan klik Precheck and Create.

Parameter	Description
API Name	Masukkan nama untuk API. Nama harus unik secara global.
Upload method	Anda dapat menggunakan Local File atau Import OSS files. Catatan File untuk upload lokal maupun impor OSS harus sesuai dengan spesifikasi OpenAPI.
OpenAPI File	Pilih file lokal atau tempel konten teksnya. Ukuran file tidak boleh melebihi 30 MB.
Region selection	Pilih wilayah tempat sumber daya OSS Anda berada.
OSS bucket	Pilih Bucket OSS. Bucket yang tidak memiliki atribut wilayah tidak didukung.
Version Management	Tentukan apakah akan mengaktifkan manajemen versi API. Versi API yang berbeda bersifat independen. Mereka menggunakan nama API yang sama tetapi dapat memiliki informasi dasar dan operasi yang berbeda. Untuk mengakses versi tertentu, sertakan identifikasi versinya dalam permintaan. Jika Anda mengaktifkan Version Management, Anda juga harus mengonfigurasi Usage. Catatan Jika Anda mengatur Usage ke Query, Anda harus mengonfigurasi parameter Add Query. Jika Anda mengatur Usage ke Header, Anda harus mengonfigurasi parameter Add Header.
Usage	Identifikasi versi dapat diteruskan melalui Path, parameter Query, atau Header. Path: Path permintaan lengkapnya adalah `/{base path}/{version_number}/{operation_path}`. Query: Path permintaan lengkapnya adalah `/{base path}/{operation_path}`. Permintaan harus menyertakan parameter query yang Anda tentukan di Add Query, dengan nilainya diatur ke nomor versi. Header: Path permintaan lengkapnya adalah `/{base path}/{operation_path}`. Permintaan harus menyertakan header yang Anda tentukan di Add Header, dengan nilainya diatur ke nomor versi.
Description	Masukkan deskripsi untuk API.
Resource Group	Pilih kelompok sumber daya target. Untuk membuat yang baru, klik Create Resource Group di sebelah kanan.

Di dalam instans

Masuk ke Cloud-native API Gateway console.
Di panel navigasi sebelah kiri, klik Instances. Di bilah menu atas, pilih wilayah.
Di halaman Instances, klik Instance ID target untuk membuka halaman Overview. Di panel navigasi sebelah kiri, klik API, lalu klik Create API.

Pada kartu REST API, klik Import. Di panel Create File based on OpenAPI, konfigurasikan parameter dan klik Precheck and Create.

Parameter	Description
API Name	Masukkan nama untuk API. Nama harus unik secara global.
Domain Name	Pilih satu atau beberapa nama domain untuk API. Untuk membuat nama domain baru, klik Add Domain Name.
Upload method	Anda dapat menggunakan Local File atau Import OSS files. Catatan File untuk upload lokal maupun impor OSS harus sesuai dengan spesifikasi OpenAPI.
OpenAPI File	Pilih file lokal atau tempel konten teksnya. Ukuran file tidak boleh melebihi 30 MB.
Region selection	Pilih wilayah tempat sumber daya OSS Anda berada.
OSS bucket	Pilih Bucket OSS. Bucket yang tidak memiliki atribut wilayah tidak didukung.
Version Management	Tentukan apakah akan mengaktifkan manajemen versi API. Versi API yang berbeda bersifat independen. Mereka menggunakan nama API yang sama tetapi dapat memiliki informasi dasar dan operasi yang berbeda. Untuk mengakses versi tertentu, sertakan identifikasi versinya dalam permintaan. Jika Anda mengaktifkan Version Management, Anda juga harus mengonfigurasi Usage. Catatan Jika Anda mengatur Usage ke Query, Anda harus mengonfigurasi parameter Add Query. Jika Anda mengatur Usage ke Header, Anda harus mengonfigurasi parameter Add Header.
Usage	Identifikasi versi dapat diteruskan melalui Path, parameter Query, atau Header. Path: Path permintaan lengkapnya adalah `/{base path}/{version_number}/{operation_path}`. Query: Path permintaan lengkapnya adalah `/{base path}/{operation_path}`. Permintaan harus menyertakan parameter query yang Anda tentukan di Add Query, dengan nilainya diatur ke nomor versi. Header: Path permintaan lengkapnya adalah `/{base path}/{operation_path}`. Permintaan harus menyertakan header yang Anda tentukan di Add Header, dengan nilainya diatur ke nomor versi.
Description	Masukkan deskripsi untuk API.
Resource Group	Pilih kelompok sumber daya target. Untuk membuat yang baru, klik Create Resource Group di sebelah kanan.
Scenario	Pilih skenario penggunaan untuk operasi ini. Skema dasar: Single Service. Skema rilis canary: By Percentage (Multi-service), By Content (Multi-service), dan By Tag (Proportion-based Routing). Catatan Jumlah persentase traffic untuk semua layanan target harus 100%.
Backend Services	Asosiasikan layanan backend dari gateway atau VPC saat ini. Jika belum ada layanan, klik Create Service untuk membuatnya. Penting Saat Anda membuat layanan baru, informasi port-nya mungkin tidak langsung muncul. Buka daftar drop-down Service Name dan klik Refresh. Informasi ini disinkronkan secara asinkron dan mungkin memerlukan waktu sejenak untuk muncul.

Tambahkan operasi

Di halaman detail REST API, klik Add Operation.

Di panel Add Operation, konfigurasikan parameter dan klik Add.

Parameter	Description
Operation Name	Masukkan nama untuk operasi. Nama harus unik dalam API tersebut.
Operation Path	Path permintaan untuk operasi ini.
Method	Metode HTTP untuk operasi ini. Kombinasi path operasi dan metode harus unik dalam API tersebut.
Description	Masukkan deskripsi untuk operasi.
Request Definition	Anda dapat mendefinisikan parameter Header, Query, dan path, serta Body. Parameter path dapat didefinisikan dalam path operasi dengan salah satu dari tiga format berikut: /books/{bookId} /books/[bookId] /books/:bookId Kami menyarankan Anda menggunakan format `{bookId}`. Catatan Definisi ini hanya digunakan untuk pembuatan SDK dan dokumentasi, dan tidak divalidasi saat runtime.
Response Definition	Menentukan struktur data respons untuk kode status yang berbeda. Definisi ini hanya digunakan untuk pembuatan dokumentasi dan tidak divalidasi saat runtime.
Mock	Konfigurasi mock hanya berlaku jika API dipublikasikan ke lingkungan mock. Catatan Fitur ini hanya tersedia untuk API yang dibuat di luar instans.
Consumer Authentication	Tentukan apakah akan mengaktifkan autentikasi konsumen. Secara default dinonaktifkan. Jika diaktifkan, Anda harus mengikat consumer authorization ke operasi ini agar dapat diakses.