全部产品
Search

搜索本产品

    API Gateway：Kelola REST API

    文档中心

    API Gateway：Kelola REST API

    更新时间：Nov 10, 2025

    Topik ini menjelaskan cara mengelola REST API melalui Konsol, termasuk operasi utama seperti mempublikasikan, mengimpor, mengekspor, dan membatalkan publikasi API. Anda juga dapat menghasilkan SDK dan dokumentasinya dengan satu klik di Konsol untuk membantu mengelola dan mengintegrasikan API secara efisien, sehingga meningkatkan kenyamanan proses pengembangan.

    Publikasikan API

    Prasyarat

    Sebelum mempublikasikan API, Anda perlu mendefinisikan dan membuat operasi dalam API tersebut.

    Prosedur

    Cloud-native API Gateway menyediakan dua cara untuk mempublikasikan API: di luar instans dan di dalam instans:

    API di luar instans

    1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API, lalu pilih Wilayah di bilah menu atas.

    2. Klik API target, lalu klik Publish di pojok kanan atas.

    3. Pada panel Publish API, konfigurasi parameter terkait, lalu klik Publish.

      Item Konfigurasi

      Deskripsi

      Domain Name

      Pilih Nama domain untuk mempublikasikan API. API yang dipublikasikan dapat diakses menggunakan Nama domain tersebut.

      Jika tidak tersedia Nama domain, Anda dapat mengklik Add Domain Name. Untuk informasi selengkapnya, lihat Create a domain name.

      Instance

      Pilih instans Cloud-native API Gateway yang telah dibuat. Lingkungan bisnis yang berbeda dapat dibedakan berdasarkan instans yang berbeda untuk menerapkan publikasi API di beberapa lingkungan.

      Scenarios

      Scenarios mencakup skenario dasar dan skenario grayscale. Untuk informasi selengkapnya tentang jenis layanan target yang berbeda, lihat Routing.

      Skenario Dasar

      • Mock: Tanggapan dari operasi mengembalikan konfigurasi mock dalam definisi operasi. Jika operasi tidak memiliki konfigurasi mock yang ditentukan, operasi tersebut tidak dapat diakses.

        Catatan

        Jika Anda ingin mempublikasikan API ke skenario Mock, pastikan bahwa tanggapan mock dikonfigurasi untuk setidaknya satu operasi dalam API tersebut. Jika tidak, API gagal dipublikasikan.

      • Single Service: Semua permintaan lalu lintas diteruskan ke layanan backend tertentu (skenario yang paling umum digunakan).

      Skenario Grayscale

      • By Proportion (Multiple Services): Seluruh lalu lintas didistribusikan ke layanan backend yang sesuai secara proporsional, umumnya digunakan dalam skenario peralihan lalu lintas dan rilis bertahap.

        Catatan

        Bobot semua layanan harus berjumlah 100.

      • By Content (Multiple Services): Seluruh lalu lintas didistribusikan ke layanan backend yang sesuai berdasarkan kondisi pencocokan. Jika opsi Default dipilih untuk suatu kondisi pencocokan, lalu lintas akan masuk ke layanan backend yang sesuai dengan entri tersebut ketika tidak ada aturan pencocokan lain yang terpenuhi.

        • Tipe kondisi pencocokan yang didukung: sama dengan, awalan, dan ekspresi reguler.

        • Tipe parameter yang didukung: Query dan Header.

        Logika operasi "dan" digunakan antara beberapa kondisi pencocokan.

        Penting

        Hanya satu entri yang dapat memilih opsi Default, dan kondisi pencocokan untuk entri lainnya tidak boleh kosong.

      • Tag-based Routing (By Proportion): Dalam skenario routing berbasis tag, seluruh lalu lintas didistribusikan secara proporsional ke beberapa versi dari beberapa layanan backend. Dalam skenario grayscale end-to-end, disarankan untuk menggunakan routing layanan tunggal terlebih dahulu guna mendapatkan kinerja dan pengalaman yang lebih baik.

      Backend Service

      Asosiasikan layanan backend di bawah gerbang/VPC. Jika tidak ada layanan backend di bawah gerbang, Anda dapat mengklik Create Service. Untuk informasi selengkapnya, lihat Create a service.

      Publication Description

      Masukkan deskripsi untuk API yang dipublikasikan.

    API di dalam instans

    1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instances, lalu pilih Wilayah di bilah menu atas.

    2. Pada halaman Instances, klik ID instans gerbang target. Di panel navigasi sebelah kiri, pilih API, lalu klik API target.

    3. Klik Publish di pojok kanan atas. Pada panel Publish API, konfigurasi parameter terkait, lalu klik Publish.

      Item Konfigurasi

      Deskripsi

      Instance

      Instans Cloud-native API Gateway yang telah dibuat. Lingkungan bisnis yang berbeda dapat dibedakan berdasarkan instans yang berbeda untuk menerapkan publikasi API di beberapa lingkungan.

      VPC

      VPC tempat operasi instans berada.

      Publication Scope

      Cakupan publikasi operasi tingkat API. Anda dapat memilih nama operasi untuk melihat detail operasi yang terpengaruh.

      Publication Description

      Masukkan deskripsi untuk API yang dipublikasikan.

    Tambahkan Versi API

    Penting

    Saat ini, hanya API yang dibuat di luar instans yang mendukung penambahan versi.

    1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API, lalu pilih Wilayah di bilah menu atas.

    2. Klik API target, lalu klik More Operations > Add Version di pojok kanan atas. Lengkapi konfigurasi terkait:

      Item Konfigurasi

      Deskripsi

      Usage Method

      Mendukung tiga metode: Path, Query, dan Header.

      Catatan

      • Ketika Anda memilih Usage Method sebagai Query, Anda perlu mengonfigurasi parameter Add Query.

      • Ketika Anda memilih Usage Method sebagai Header, Anda perlu mengonfigurasi parameter Add Header.

      • Ketika menggunakan Path, jalur akses lengkapnya harus berupa: /jalur dasar API/versi/jalur operasi.

      • Ketika menggunakan Query, jalur akses lengkapnya adalah: /jalur dasar API/jalur operasi, dan parameter permintaan perlu mengonfigurasi parameter Add Query sebagai nomor versi.

      • Ketika menggunakan Header, jalur akses lengkapnya adalah: /jalur dasar API/jalur operasi, dan header permintaan perlu mengonfigurasi parameter Add Header sebagai nomor versi.

    3. (Opsional) Setelah menambahkan, Anda dapat mengklik Version di bagian atas halaman untuk beralih versi.

    Lihat Versi Historis

    Catatan

    Riwayat publikasi menyimpan 10 catatan terakhir.

    1. Cloud-native API Gateway menyediakan dua cara untuk melihat versi historis: di luar instans dan di dalam instans:

      API di luar instans

      1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API, lalu pilih Wilayah di bilah menu atas.

      2. Klik API target, lalu klik tab Publication History.

      API di dalam instans

      1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instances, lalu pilih Wilayah di bilah menu atas.

      2. Pada halaman Instances, klik ID instans gerbang target. Di panel navigasi sebelah kiri, pilih API, klik API target, lalu klik tab Publication History.

    2. Klik View pada kolom Actions dari versi historis target untuk melihat detail versi historis tersebut.

    Buat SDK dan Dokumentasi

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

      API di luar instans

      1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API, lalu pilih Wilayah di bilah menu atas.

      2. Klik API target. Klik More Operations > SDK & Documentation Generation di pojok kanan atas.

      API di dalam instans

      1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instances, lalu pilih Wilayah di bilah menu atas.

      2. Pada halaman Instances, klik ID instans gerbang target. Di panel navigasi sebelah kiri, pilih API, lalu klik API target.

      3. Klik More Operations > SDK & Documentation Generation di pojok kanan atas.

    2. Pada kotak dialog SDK & Documentation Generation, konfigurasi parameter terkait, lalu klik Generate And Download.

      Item Konfigurasi

      Deskripsi

      API Version

      Pilih versi API yang ingin Anda buat SDK dan dokumentasinya.

      Catatan

      • API yang dibuat di dalam instans tidak memiliki kemampuan manajemen versi, sehingga opsi ini tidak tersedia.

      • Untuk API yang dibuat di luar instans, Anda dapat memilih apakah akan mengaktifkan kemampuan manajemen versi API atau tidak. Jika manajemen versi tidak diaktifkan saat membuat API, opsi ini tidak tersedia.

      SDK Language

      Pilih bahasa untuk membuat SDK. Nilai yang valid: Java, Golang, Python, Node.js, TypeScript, dan Swift.

    3. Tunggu hingga SDK dan dokumentasi selesai dibuat dan diunduh secara otomatis. Keduanya akan diunduh sebagai paket terkompresi ke komputer lokal Anda. Buka jalur unduhan browser untuk melihat paket tersebut.

      Catatan

      Setelah diekstrak, Anda dapat merujuk ke dokumen README.md sebagai panduan penggunaan SDK. Dokumen ini berisi informasi dasar yang diperlukan untuk menggunakan SDK.

    Impor API

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

      API di luar instans

      1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API, lalu pilih Wilayah di bilah menu atas.

      2. Klik API target. Klik More Operations > Import di pojok kanan atas.

      API di dalam instans

      1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instances, lalu pilih Wilayah di bilah menu atas.

      2. Pada halaman Instances, klik ID instans gerbang target. Di panel navigasi sebelah kiri, pilih API, lalu klik API target.

      3. Klik More Operations > Import di pojok kanan atas.

    2. Pada panel Create File Based On OpenAPI, konfigurasi parameter terkait, lalu klik Dry Run And Create.

    Ekspor API

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

      API di luar instans

      1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API, lalu pilih Wilayah di bilah menu atas.

      2. Klik API target. Klik More Operations > Export di pojok kanan atas.

      API di dalam instans

      1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instances, lalu pilih Wilayah di bilah menu atas.

      2. Pada halaman Instances, klik ID instans gerbang target. Di panel navigasi sebelah kiri, pilih API, lalu klik API target.

      3. Klik More Operations > Export di pojok kanan atas.

    2. Pada kotak dialog Export, klik Confirm. Browser akan mengunduh API ke jalur unduhan default di komputer lokal Anda.

    Batalkan Publikasi API

    Penting

    Setelah pembatalan publikasi, semua Nama domain terkait tidak akan dapat mengakses operasi di bawah API tersebut. Meskipun instans API akan berhenti memproses permintaan, konfigurasi dan riwayatnya tetap disimpan dalam sistem. Harap lakukan operasi ini dengan hati-hati.

    1. Cloud-native API Gateway menyediakan dua cara untuk membatalkan publikasi API: di luar instans dan di dalam instans:

      API di luar instans

      1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API, lalu pilih Wilayah di bilah menu atas.

      2. Klik API target. Klik More Operations > Unpublish di pojok kanan atas.

      API di dalam instans

      1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instances, lalu pilih Wilayah di bilah menu atas.

      2. Pada halaman Instances, klik ID instans gerbang target. Di panel navigasi sebelah kiri, pilih API, lalu klik API target.

      3. Klik More Operations > Unpublish di pojok kanan atas.

    2. Pada kotak dialog Confirm Unpublish, klik Unpublish.

    Hapus API

    Penting

    • Jika API saat ini memiliki instans yang dipublikasikan, semua instans tersebut harus dibatalkan publikasinya sebelum melakukan operasi penghapusan.

    • Menghapus API akan sepenuhnya menghapus konfigurasi, dokumentasi, dan riwayat API tersebut, serta tidak dapat dipulihkan. Harap lakukan operasi ini dengan hati-hati.

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

      API di luar instans

      1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih API, lalu pilih Wilayah di bilah menu atas.

      2. Klik API target. Klik More Operations > Delete di pojok kanan atas.

      API di dalam instans

      1. Masuk ke Konsol Cloud-native API Gateway. Di panel navigasi sebelah kiri, pilih Instances, lalu pilih Wilayah di bilah menu atas.

      2. Pada halaman Instances, klik ID instans gerbang target. Di panel navigasi sebelah kiri, pilih API, lalu klik API target.

      3. Klik More Operations > Delete di pojok kanan atas.

    2. Pada kotak dialog Confirm Delete, klik Delete.