Topik ini menjelaskan cara mengelola lingkungan di API Gateway, termasuk membuat lingkungan kustom, menggunakan lingkungan untuk mengisolasi layanan backend, dan menghapus lingkungan.
Apa itu pengelolaan lingkungan?
Pengelolaan lingkungan adalah proses pengelolaan lingkungan yang dibuat dan dipelihara untuk tujuan berbeda pada setiap tahap, seperti pengembangan perangkat lunak, pengujian, dan penyebaran. Umumnya, lingkungan terbagi menjadi tiga kategori: pengujian, staging, dan produksi. Pengelolaan lingkungan yang tepat membantu memastikan kualitas, stabilitas, dan keamanan perangkat lunak serta mendukung kerja tim.
API Gateway menyediakan tiga lingkungan bawaan: TEST, PRE, dan RELEASE. Selain itu, Anda dapat membuat dan menggunakan lingkungan kustom sesuai dengan kebutuhan bisnis Anda. Dengan satu set konfigurasi API yang sama, Anda dapat mengisolasi layanan backend dari berbagai tahap R&D, meningkatkan efisiensi R&D dan kemampuan pengelolaan API Anda.
Penggunaan lingkungan API umumnya melibatkan tiga langkah:
(Opsional) Buat dan kelola lingkungan kustom: Gunakan Konsol API Gateway untuk membuat dan mengelola lingkungan Anda sendiri.
Konfigurasikan layanan backend Anda: Atur konfigurasi berbeda untuk layanan backend di setiap lingkungan (pengujian, staging, dan produksi), sehingga permintaan API diarahkan ke URL backend yang sesuai.
Konfigurasikan klien Anda: Pengguna harus secara eksplisit menentukan URL untuk mengirim permintaan pada klien mereka. Anda dapat mengikat nama domain berbeda ke grup API atau meminta pengguna untuk menambahkan header X-Ca-Stage dalam permintaan API mereka.
1. Buat lingkungan
API Gateway menyediakan tiga lingkungan bawaan: TEST, PRE, dan RELEASE. Jika lingkungan ini tidak memenuhi kebutuhan bisnis Anda, Anda dapat membuat lingkungan kustom.
Masuk ke Konsol API Gateway untuk melihat lingkungan yang tersedia.
Untuk membuat lingkungan baru, klik Create Environment. Di kotak dialog Create Environment, masukkan nama lingkungan, alias, dan deskripsi. Nama lingkungan dan alias harus unik secara global.
Nama Lingkungan: Harus 2 hingga 10 karakter panjangnya, hanya boleh berisi huruf besar dan angka, serta dimulai dengan huruf besar.
Alias: Nama tampilan lingkungan. Harus 2 hingga 50 karakter panjangnya dan dapat berisi huruf, angka, serta garis bawah (_).
Deskripsi: Penjelasan tentang lingkungan.
Klik Konfirmasi untuk menyelesaikan pembuatan lingkungan.
2. Gunakan lingkungan
2.1 Buat layanan backend dan konfigurasikan URL lingkungan untuk layanan tersebut
Disarankan untuk mengelola aplikasi backend API menggunakan layanan backend. Anda dapat mengonfigurasi URL lingkungan berbeda untuk layanan backend guna membedakan aplikasi di setiap lingkungan. Untuk informasi lebih lanjut, lihat langkah 1 dan 2 di Gunakan Layanan Backend untuk Membuat dan Mengelola API.
2.2 Publikasikan API ke lingkungan
Setelah membuat dan mengonfigurasi layanan backend, Anda perlu membuat API agar pengguna dapat memanggilnya. Untuk informasi lebih lanjut tentang cara membuat dan men-debug API, lihat langkah 3, 4, dan 5 di Gunakan Layanan Backend untuk Membuat dan Mengelola API. Anda dapat mempublikasikan API ke semua lingkungan yang tersedia, termasuk lingkungan sistem TEST, PRE, dan RELEASE serta lingkungan kustom Anda.
2.3 Gunakan header X-Ca-Stage untuk memanggil API di lingkungan tertentu
Saat men-debug API, Anda dapat mencoba memanggil API menggunakan nama domain tingkat kedua yang disediakan sistem atau header permintaan X-Ca-Stage. Jika Anda telah mengikat nama domain independen ke grup API tempat API Anda berada dan parameter Environment diatur ke Default (X-Ca-Stage), pengguna dapat menggunakan header X-Ca-Stage untuk menentukan lingkungan ke mana mereka ingin mengirim permintaan API.
Untuk memanggil API di lingkungan RELEASE, pengguna tidak perlu menentukan parameter X-Ca-Stage dalam permintaan API.
Untuk memanggil API di lingkungan PRE, pengguna harus menambahkan header X-Ca-Stage: PRE ke setiap permintaan API.
Untuk memanggil API di lingkungan TEST, pengguna harus menambahkan header X-Ca-Stage: TEST ke setiap permintaan API.
Untuk memanggil API di lingkungan kustom, pengguna harus menambahkan header X-Ca-Stage: environment name ke setiap permintaan API. Gantilah environment name dengan nama lingkungan sebenarnya.
2.4 Ikat nama domain independen ke lingkungan tertentu
Anda dapat mengikat nama domain terpisah untuk setiap lingkungan. Dengan cara ini, pengguna tidak perlu menggunakan header X-Ca-Stage untuk menentukan lingkungan saat memanggil API. Anda dapat memilih lingkungan yang diinginkan saat mengikat nama domain independen ke grup API. Untuk informasi lebih lanjut tentang cara mengikat nama domain independen, lihat Ikat Nama Domain Kustom untuk Memungkinkan Panggilan API.
Pengikatan nama domain memiliki prioritas lebih tinggi daripada header X-Ca-Stage. Artinya, meskipun pengguna menentukan header X-Ca-Stage dalam permintaan mereka, API Gateway akan merutekan permintaan berdasarkan konfigurasi pengikatan.
3. Hapus lingkungan
Masuk ke Konsol API Gateway untuk melihat lingkungan yang tersedia.
Temukan lingkungan yang ingin dihapus dan klik Hapus di kolom Tindakan.
Lingkungan bawaan tidak dapat dihapus.
Jika lingkungan memiliki layanan backend terkait, lingkungan tersebut tidak dapat dihapus.
Jika lingkungan memiliki API yang diterbitkan, lingkungan tersebut tidak dapat dihapus.