All Products
Search

This Product

    API Gateway:Mengelola REST API

    Document Center

    API Gateway:Mengelola REST API

    Last Updated:May 28, 2026

    Publikasikan, impor, ekspor, dan batalkan publikasi REST API di konsol Cloud-native API Gateway. Anda juga dapat menghasilkan SDK dan dokumentasinya dalam satu klik.

    Publikasikan API

    Prasyarat

    Sebelum mempublikasikan API, pastikan operasi-operasinya telah didefinisikan dan dibuat.

    Prosedur

    Cloud-native API Gateway mendukung dua jenis API: Shared API dan Instance-scoped API.

    Shared API

    1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API. Di bilah navigasi atas, pilih wilayah.

    2. Klik nama API yang dituju. Di pojok kanan atas, klik Publish.

    3. Di panel Publish API, konfigurasikan parameter dan klik Publish.

      Parameter

      Deskripsi

      Domain Name

      Pilih nama domain. API dapat diakses melalui domain ini setelah dipublikasikan.

      Jika tidak tersedia nama domain, klik Add Domain Name. Untuk informasi selengkapnya, lihat Buat nama domain.

      Instance

      Pilih instans gateway. Gunakan instans berbeda untuk mengisolasi lingkungan.

      Scenario

      Skenario mencakup rilis dasar dan rilis canary. Untuk tipe layanan backend, lihat Routing.

      Basic scenarios

      • Mock: Mengembalikan respons mock berdasarkan konfigurasi mock operasi tersebut. Operasi tanpa konfigurasi mock tidak dapat diakses.

        Catatan

        Untuk mempublikasikan dalam skenario mock, minimal satu operasi harus memiliki konfigurasi mock yang diaktifkan. Jika tidak, publikasi akan gagal.

      • Single Service: Mengarahkan semua permintaan ke satu layanan backend. Kasus penggunaan paling umum.

      Canary release scenarios

      • By Percentage (Multi-service): Mendistribusikan traffic ke layanan backend berdasarkan persentase. Digunakan untuk pergeseran traffic dan rilis canary.

        Catatan

        Jumlah bobot dari semua layanan harus 100.

      • By Content (Multi-service): Mengarahkan traffic ke layanan backend berbeda berdasarkan kondisi pencocokan. Aturan yang ditandai sebagai Default menangani traffic yang tidak cocok.

        • Tipe pencocokan yang didukung: Equal, Prefix, dan Regex.

        • Lokasi parameter yang didukung: Query dan Header.

        Beberapa kondisi digabungkan menggunakan logika AND.

        Penting

        Hanya satu aturan yang dapat ditetapkan sebagai Default. Semua aturan lain harus memiliki kondisi pencocokan yang tidak kosong.

      • By Tag (Proportion-based Routing): Mendistribusikan traffic berdasarkan persentase di berbagai versi layanan backend. Untuk rilis canary end-to-end, disarankan menggunakan routing single-service.

      Backend Services

      Asosiasikan layanan backend di gateway atau VPC. Jika tidak tersedia, klik Create Service untuk Buat layanan.

      Publish Description

      Masukkan deskripsi untuk publikasi ini.

    Instance-scoped API

    1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instance. Di bilah navigasi atas, pilih wilayah.

    2. Di halaman Instance, klik ID instans gateway yang dituju. Di panel navigasi sebelah kiri, pilih API, lalu klik API yang dituju.

    3. Di pojok kanan atas, klik Publish. Di panel Publish API, konfigurasikan parameter dan klik Publish.

      Parameter

      Deskripsi

      Instance

      Instans tempat API dipublikasikan. Gunakan instans berbeda untuk mengisolasi lingkungan.

      VPC

      VPC tempat instans berada.

      Publish Scope

      Cakupan operasi API yang akan dipublikasikan. Klik nama operasi untuk melihat detailnya.

      Publish Description

      Masukkan deskripsi untuk publikasi ini.

    Tambahkan versi API

    Penting

    Saat ini, Anda hanya dapat menambahkan versi pada Shared API.

    1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API, dan di bilah navigasi atas, pilih wilayah.

    2. Klik API yang dituju. Di pojok kanan atas, pilih More > Add Version, lalu konfigurasikan parameter berikut:

      Parameter

      Deskripsi

      Usage

      Metode yang didukung: Path, Query, dan Header.

      Catatan

      • Jika Anda memilih Query sebagai Usage, Anda harus mengonfigurasi parameter Add Query.

      • Jika Anda memilih Header sebagai Usage, Anda harus mengonfigurasi parameter Add Header.

      • Saat menggunakan metode Path, path permintaan lengkap harus berupa: /APIBasePath/VersionNumber/OperationPath.

      • Saat menggunakan metode Query, gunakan path /APIBasePath/OperationPath dan sertakan nomor versi dalam parameter kueri yang ditentukan oleh Add Query.

      • Saat menggunakan metode Header, gunakan path /APIBasePath/OperationPath dan sertakan nomor versi dalam header permintaan yang ditentukan oleh Add Header.

    3. (Opsional) Setelah menambahkan versi, klik tab Version di bagian atas halaman untuk beralih antarversi.

    Lihat riwayat publikasi

    Catatan

    10 catatan publikasi terakhir disimpan.

    1. Lihat riwayat publikasi untuk Shared API atau Instance-scoped API.

      Shared API

      1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API. Di bilah navigasi atas, pilih wilayah.

      2. Klik API yang dituju, lalu klik tab Publish History.

      Instance-scoped API

      1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instance. Di bilah navigasi atas, pilih wilayah.

      2. Di halaman Instance, klik ID instans gateway yang dituju. Di panel navigasi sebelah kiri, pilih API, klik API yang dituju, lalu klik tab Publish History.

    2. Di kolom Actions untuk versi historis, klik View untuk melihat detailnya.

    Hasilkan SDK dan dokumentasi

    1. Hasilkan SDK dan dokumentasi untuk Shared API atau Instance-scoped API.

      Shared API

      1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API. Di bilah navigasi atas, pilih wilayah.

      2. Klik API yang dituju. Di pojok kanan atas, pilih More > Generate SDK & Documentation.

      Instance-scoped API

      1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instance. Di bilah navigasi atas, pilih wilayah.

      2. Di halaman Instance, klik ID instans gateway yang dituju. Di panel navigasi sebelah kiri, pilih API, lalu klik API yang dituju.

      3. Di pojok kanan atas, pilih More > Generate SDK & Documentation.

    2. Di kotak dialog More > Generate SDK & Documentation, konfigurasikan parameter dan klik Generate and Download.

      Parameter

      Deskripsi

      API Version

      Pilih versi API untuk pembuatan SDK dan dokumentasi.

      Catatan

      • Instance-scoped API tidak mendukung versioning, sehingga opsi ini tidak tersedia.

      • Untuk Shared API, opsi ini tersedia hanya jika Anda mengaktifkan manajemen versi saat membuat API.

      Language

      Bahasa SDK yang didukung: Java, Golang, Python, Node.js, TypeScript, dan Swift.

    3. Paket terkompresi akan diunduh secara otomatis ke folder unduhan default browser Anda.

      Catatan

      Setelah mengekstrak paket, lihat file README.md untuk instruksi penggunaan SDK.

    Impor API

    1. Impor definisi API untuk Shared API atau Instance-scoped API.

      Shared API

      1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API. Di bilah navigasi atas, pilih wilayah.

      2. Klik API yang dituju. Di pojok kanan atas, pilih More > Import.

      Instance-scoped API

      1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instance. Di bilah navigasi atas, pilih wilayah.

      2. Di halaman Instance, klik ID instans gateway yang dituju. Di panel navigasi sebelah kiri, pilih API, lalu klik API yang dituju.

      3. Di pojok kanan atas, pilih More > Import.

    2. Di panel Create File based on OpenAPI, konfigurasikan parameter, lalu klik Precheck and Create.

    Ekspor API

    1. Ekspor definisi API untuk Shared API atau Instance-scoped API.

      Shared API

      1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API. Di bilah navigasi atas, pilih wilayah.

      2. Klik API yang dituju. Di pojok kanan atas, pilih More > Import.

      Instance-scoped API

      1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instance. Di bilah navigasi atas, pilih wilayah.

      2. Di halaman Instance, klik ID instans gateway yang dituju. Di panel navigasi sebelah kiri, pilih API, lalu klik API yang dituju.

      3. Di pojok kanan atas, pilih More > Import.

    2. Di kotak dialog Export, klik OK. Definisi API akan diunduh ke folder unduhan default browser Anda.

    Batalkan publikasi API

    Penting

    Setelah Anda membatalkan publikasi API, operasinya menjadi tidak dapat diakses melalui nama domain terkait. Permintaan tidak lagi diproses, tetapi konfigurasi dan riwayat publikasi tetap disimpan. Lakukan dengan hati-hati.

    1. Batalkan publikasi Shared API atau Instance-scoped API.

      Shared API

      1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API. Di bilah navigasi atas, pilih wilayah.

      2. Klik API yang dituju. Di pojok kanan atas, pilih More > Shutdown.

      Instance-scoped API

      1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instance. Di bilah navigasi atas, pilih wilayah.

      2. Di halaman Instance, klik ID instans gateway yang dituju. Di panel navigasi sebelah kiri, pilih API, lalu klik API yang dituju.

      3. Di pojok kanan atas, pilih More > Shutdown.

    2. Di kotak dialog Confirm Unpublish, klik Shutdown.

    Hapus API

    Penting

    • Sebelum menghapus API yang telah dipublikasikan, Anda harus terlebih dahulu membatalkan publikasinya dari semua instans.

    • Menghapus API akan menghapus permanen konfigurasi, dokumentasi, dan riwayatnya. Tindakan ini tidak dapat dikembalikan. Lakukan dengan hati-hati.

    1. Hapus Shared API atau Instance-scoped API.

      Shared API

      1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API. Di bilah navigasi atas, pilih wilayah.

      2. Klik API yang dituju. Di pojok kanan atas, pilih More > Delete.

      Instance-scoped API

      1. Masuk ke konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instance. Di bilah navigasi atas, pilih wilayah.

      2. Di halaman Instance, klik ID instans gateway yang dituju. Di panel navigasi sebelah kiri, pilih API, lalu klik API yang dituju.

      3. Di pojok kanan atas, pilih More > Delete.

    2. Di kotak dialog Confirm deletion, klik Delete.