Buat API dan tambahkan operasi - API Gateway

Cloud-native API Gateway memungkinkan Anda membuat API baik di dalam maupun di luar instans. Anda dapat membuat API melalui konsol atau dengan mengimpor file OpenAPI. Topik ini menjelaskan cara membuat REST API dan menambahkan operasi.

Skenario

Dua metode pembuatan API—di dalam dan di luar instans—berlaku untuk skenario berikut:

Buat API di dalam instans

Manajemen sumber daya khusus: API digunakan secara eksklusif dalam instans tertentu untuk mengelola sumber daya atau logika internal tertentu.
Keamanan dan isolasi: Data atau fitur memerlukan isolasi ketat demi keamanan dan hanya dipanggil dari dalam instans tersebut.
Konfigurasi layanan yang disederhanakan: Metode ini menyederhanakan konfigurasi dan manajemen API dalam instans tertentu.

Buat API di luar instans

Akses bersama lintas-instans: Beberapa instans dapat berbagi informasi definisi API.
Manajemen dan pemantauan terpusat: Metode ini menyediakan kontrol akses terpadu, pencatatan log, dan manajemen lalu lintas.

Buat REST API di konsol

Cloud-native API Gateway mendukung dua metode pembuatan API: di dalam instans dan di luar instans.

API di luar instans

Masuk ke Konsol Cloud-native API Gateway.
Pada panel navigasi di sebelah kiri, klik API. Pada bilah menu atas, pilih Wilayah.
Klik Create API.

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

Item Konfigurasi	Deskripsi
API Name	Masukkan nama kustom untuk API. Nama API harus unik secara global.
Base Path	Jalur dasar API. Saat Anda mengakses operasi tertentu, jalur lengkapnya adalah `http(s)://{Domain Name}/{BasePath}/{Operation Path}`.
Version Management	Menentukan apakah akan mengaktifkan manajemen versi API. API dengan versi berbeda diperlakukan sebagai API independen. Mereka menggunakan nama API yang sama tetapi dapat memiliki informasi dasar dan detail operasi yang berbeda. Anda harus menentukan pengenal versi untuk mengakses versi tertentu. Jika Anda mengaktifkan Version Management, Anda harus mengonfigurasi Usage Method. Catatan Jika Anda mengatur Usage Method ke Query, Anda harus mengonfigurasi parameter Add Query. Jika Anda mengatur Usage Method ke Header, Anda harus mengonfigurasi parameter Add Header.
Usage Method	Mendukung Path, Query, dan Header. Jika Anda menggunakan Path, jalur akses lengkapnya adalah /API Base Path/Version Number/Operation Path. Jika Anda menggunakan Query, jalur akses lengkapnya adalah /API Base Path/Operation Path. Dalam parameter permintaan, Anda harus mengatur parameter Add Query ke nomor versi. Jika Anda menggunakan Header, jalur akses lengkapnya adalah /API Base Path/Operation Path. Dalam header permintaan, Anda harus mengatur parameter Add Header ke nomor versi.
Description	Masukkan deskripsi untuk API.
Resource Group	Pilih kelompok sumber daya target. Anda dapat mengklik Create Resource Group di sebelah kanan.

Klik Create API.

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

Item Konfigurasi	Deskripsi
API Name	Masukkan nama kustom untuk API. Nama API harus unik secara global.
Base Path	Jalur dasar API. Saat Anda mengakses operasi tertentu, jalur lengkapnya adalah `http(s)://{Domain Name}/{BasePath}/{Operation Path}`.
Version Management	Menentukan apakah akan mengaktifkan manajemen versi API. API dengan versi berbeda diperlakukan sebagai API independen. Mereka menggunakan nama API yang sama tetapi dapat memiliki informasi dasar dan detail operasi yang berbeda. Anda harus menentukan pengenal versi untuk mengakses versi tertentu. Jika Anda mengaktifkan Version Management, Anda harus mengonfigurasi Usage Method. Catatan Jika Anda mengatur Usage Method ke Query, Anda harus mengonfigurasi parameter Add Query. Jika Anda mengatur Usage Method ke Header, Anda harus mengonfigurasi parameter Add Header.
Usage Method	Mendukung Path, Query, dan Header. Jika Anda menggunakan Path, jalur akses lengkapnya adalah /API Base Path/Version Number/Operation Path. Jika Anda menggunakan Query, jalur akses lengkapnya adalah /API Base Path/Operation Path. Dalam parameter permintaan, Anda harus mengatur parameter Add Query ke nomor versi. Jika Anda menggunakan Header, jalur akses lengkapnya adalah /API Base Path/Operation Path. Dalam header permintaan, Anda harus mengatur parameter Add Header ke nomor versi.
Description	Masukkan deskripsi untuk API.
Resource Group	Pilih kelompok sumber daya target. Anda dapat mengklik Create Resource Group di sebelah kanan.

API di dalam instans

Masuk ke Konsol Cloud-native API Gateway.
Pada panel navigasi di sebelah kiri, klik Instances. Pada bilah menu atas, pilih Wilayah.
Pada halaman Instances, klik Instance ID target untuk membuka halaman Overview. Lalu, pada panel navigasi di sebelah kiri, klik API dan klik Create API.

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

Item Konfigurasi	Deskripsi
API Name	Masukkan nama kustom untuk API. Nama API harus unik secara global.
Domain Names	Pilih nama domain untuk API. Anda dapat memilih beberapa nama domain. Untuk membuat nama domain baru, klik Add Domain Name.
Base Path	Jalur dasar API. Saat Anda mengakses operasi tertentu, jalur lengkapnya adalah `http(s)://{Domain Name}/{BasePath}/{Operation Path}`.
Version Management	Menentukan apakah akan mengaktifkan manajemen versi API. API dengan versi berbeda diperlakukan sebagai API independen. Mereka menggunakan nama API yang sama tetapi dapat memiliki informasi dasar dan detail operasi yang berbeda. Anda harus menentukan pengenal versi untuk mengakses versi tertentu. Jika Anda mengaktifkan Version Management, Anda harus mengonfigurasi Usage Method. Catatan Jika Anda mengatur Usage Method ke Query, Anda harus mengonfigurasi parameter Add Query. Jika Anda mengatur Usage Method ke Header, Anda harus mengonfigurasi parameter Add Header.
Usage Method	Mendukung Path, Query, dan Header. Jika Anda menggunakan Path, jalur akses lengkapnya adalah /API Base Path/Version Number/Operation Path. Jika Anda menggunakan Query, jalur akses lengkapnya adalah /API Base Path/Operation Path. Dalam parameter permintaan, Anda harus mengatur parameter Add Query ke nomor versi. Jika Anda menggunakan Header, jalur akses lengkapnya adalah /API Base Path/Operation Path. Dalam header permintaan, Anda harus mengatur parameter Add Header ke nomor versi.
Description	Masukkan deskripsi untuk API.
Resource Group	Pilih kelompok sumber daya target. Anda dapat mengklik Create Resource Group di sebelah kanan.
Scenario	Pilih skenario untuk operasi saat ini. Skema dasar: Single Service. Skema grayscale: By Ratio (Multi-service), By Content (Multi-service), Tag-based Routing (By Ratio). Catatan Jumlah proporsi lalu lintas untuk semua layanan target dengan bobot harus 100%.
Backend Service	Asosiasikan layanan backend di bawah gerbang atau VPC ini. Jika tidak ada layanan backend di bawah gerbang, klik Create Service untuk membuatnya. Penting Saat Anda membuat layanan baru, informasi port layanan mungkin tidak langsung muncul. Anda perlu memperluas daftar drop-down Service Name dan klik Refresh. Karena informasi port disinkronkan secara asinkron, mungkin diperlukan waktu sejenak untuk memuat dan menampilkan informasi port layanan secara lengkap.

Buat REST API dengan mengimpor file OpenAPI

Cloud-native API Gateway memungkinkan Anda membuat API dengan dua cara: pada instans tertentu atau independen dari instans.

API di luar instans

Masuk ke Konsol Cloud-native API Gateway.
Pada panel navigasi di sebelah kiri, klik API. Pada bilah menu atas, pilih Wilayah.
Klik Create API.

Pada kartu REST API, klik Import. Di panel Create From OpenAPI, konfigurasikan parameter dan klik Dry Run And Create.

Item Konfigurasi	Deskripsi
API Name	Masukkan nama kustom untuk API. Nama API harus unik secara global.
Upload Method	Mendukung Local File dan Import From OSS. Catatan File untuk unggahan lokal maupun impor dari OSS harus mematuhi spesifikasi OpenAPI.
OpenAPI File	Parameter ini dikonfigurasi saat Anda memilih Local File. Anda dapat memilih file atau menempelkan konten teks. Ukuran file dibatasi hingga 30 MB.
Select Region	Parameter ini dikonfigurasi saat Anda memilih Import from OSS. Pilih wilayah untuk memilih sumber daya OSS-nya.
OSS Bucket	Parameter ini dikonfigurasi saat Anda memilih Import from OSS. Pilih bucket OSS. Bucket tanpa atribut wilayah tidak didukung.
Version Management	Menentukan apakah akan mengaktifkan manajemen versi API. API dengan versi berbeda diperlakukan sebagai API independen. Mereka menggunakan nama API yang sama tetapi dapat memiliki informasi dasar dan detail operasi yang berbeda. Anda harus menentukan pengenal versi untuk mengakses versi tertentu. Jika Anda mengaktifkan Version Management, Anda harus mengonfigurasi Usage Method. Catatan Jika Anda mengatur Usage Method ke Query, Anda harus mengonfigurasi parameter Add Query. Jika Anda mengatur Usage Method ke Header, Anda harus mengonfigurasi parameter Add Header.
Usage Method	Mendukung Path, Query, dan Header. Jika Anda menggunakan Path, jalur akses lengkapnya adalah /API Base Path/Version Number/Operation Path. Jika Anda menggunakan Query, jalur akses lengkapnya adalah /API Base Path/Operation Path. Dalam parameter permintaan, Anda harus mengatur parameter Add Query ke nomor versi. Jika Anda menggunakan Header, jalur akses lengkapnya adalah /API Base Path/Operation Path. Dalam header permintaan, Anda harus mengatur parameter Add Header ke nomor versi.
Description	Masukkan deskripsi untuk API.
Resource Group	Pilih kelompok sumber daya target. Anda dapat mengklik Create Resource Group di sebelah kanan.

API di dalam instans

Masuk ke Konsol Cloud-native API Gateway.
Pada panel navigasi di sebelah kiri, klik Instances. Pada bilah menu atas, pilih Wilayah.
Pada halaman Instances, klik Instance ID target untuk membuka halaman Overview. Lalu, pada panel navigasi di sebelah kiri, klik API dan klik Create API.

Pada kartu REST API, klik Import. Di panel Create From OpenAPI, konfigurasikan parameter dan klik Dry Run And Create.

Item Konfigurasi	Deskripsi
API Name	Masukkan nama kustom untuk API. Nama API harus unik secara global.
Domain Names	Pilih nama domain untuk API. Anda dapat memilih beberapa nama domain. Untuk membuat nama domain baru, klik Add Domain Name.
Upload Method	Mendukung Local File dan Import From OSS. Catatan File untuk unggahan lokal maupun impor dari OSS harus mematuhi spesifikasi OpenAPI.
OpenAPI File	Parameter ini dikonfigurasi saat Anda memilih Local File. Anda dapat memilih file atau menempelkan konten teks. Ukuran file dibatasi hingga 30 MB.
Select Region	Parameter ini dikonfigurasi saat Anda memilih Import from OSS. Pilih wilayah untuk memilih sumber daya OSS-nya.
OSS Bucket	Parameter ini dikonfigurasi saat Anda memilih Import from OSS. Pilih bucket OSS. Bucket tanpa atribut wilayah tidak didukung.
Version Management	Menentukan apakah akan mengaktifkan manajemen versi API. API dengan versi berbeda diperlakukan sebagai API independen. Mereka menggunakan nama API yang sama tetapi dapat memiliki informasi dasar dan detail operasi yang berbeda. Anda harus menentukan pengenal versi untuk mengakses versi tertentu. Jika Anda mengaktifkan Version Management, Anda harus mengonfigurasi Usage Method. Catatan Jika Anda mengatur Usage Method ke Query, Anda harus mengonfigurasi parameter Add Query. Jika Anda mengatur Usage Method ke Header, Anda harus mengonfigurasi parameter Add Header.
Usage Method	Mendukung Path, Query, dan Header. Jika Anda menggunakan Path, jalur akses lengkapnya adalah /API Base Path/Version Number/Operation Path. Jika Anda menggunakan Query, jalur akses lengkapnya adalah /API Base Path/Operation Path. Dalam parameter permintaan, Anda harus mengatur parameter Add Query ke nomor versi. Jika Anda menggunakan Header, jalur akses lengkapnya adalah /API Base Path/Operation Path. Dalam header permintaan, Anda harus mengatur parameter Add Header ke nomor versi.
Description	Masukkan deskripsi untuk API.
Resource Group	Pilih kelompok sumber daya target. Anda dapat mengklik Create Resource Group di sebelah kanan.
Scenario	Pilih skenario untuk operasi saat ini. Skema dasar: Single Service. Skema grayscale: By Ratio (Multi-service), By Content (Multi-service), Tag-based Routing (By Ratio). Catatan Jumlah proporsi lalu lintas untuk semua layanan target dengan bobot harus 100%.
Backend Service	Asosiasikan layanan backend di bawah gerbang atau VPC ini. Jika tidak ada layanan backend di bawah gerbang, klik Create Service untuk membuatnya. Penting Saat Anda membuat layanan baru, informasi port layanan mungkin tidak langsung muncul. Anda perlu memperluas daftar drop-down Service Name dan klik Refresh. Karena informasi port disinkronkan secara asinkron, mungkin diperlukan waktu sejenak untuk memuat dan menampilkan informasi port layanan secara lengkap.

Tambahkan operasi

Pada halaman detail REST API, klik Add Operation.

Di panel Create Operation, konfigurasikan parameter dan klik Add.

Item Konfigurasi	Deskripsi
Operation Name	Masukkan nama kustom untuk operasi. Nama tersebut harus unik secara global dalam API.
Operation Path	Jalur spesifik dari operasi.
Method	Metode permintaan dari operasi. Kombinasi jalur operasi dan metode harus unik secara global dalam API.
Description	Deskripsi antarmuka.
Request Definition	Anda dapat mendefinisikan parameter Header, Query, dan Parameter Path, serta parameter Body. Parameter path mendukung tiga cara untuk mendefinisikan variabel dalam jalur operasi: /books/{bookId} /books/[bookId] /books/:bookId Gunakan format {bookId}. Catatan Definisi permintaan hanya digunakan untuk menghasilkan SDK dan dokumen. Definisi tersebut tidak divalidasi saat waktu proses.
Response Definition	Definisikan struktur data untuk kode tanggapan yang berbeda. Definisi kode tanggapan hanya digunakan untuk menghasilkan dokumen. Definisi tersebut tidak divalidasi saat waktu proses.
Mock	Konfigurasi mock hanya berlaku ketika API dipublikasikan dalam skenario mock. Catatan Fitur konfigurasi mock untuk REST API didukung untuk API di luar instans. Fitur ini tidak didukung untuk API di dalam instans.
Consumer Authentication	Aktifkan atau nonaktifkan autentikasi konsumen. Fitur ini dinonaktifkan secara default. Jika Anda mengaktifkan autentikasi konsumen, Anda harus menyambungkan otorisasi konsumen ke operasi saat ini. Jika tidak, operasi tersebut tidak dapat diakses.