Saat membuat permintaan API, sering kali diperlukan untuk beralih antara lingkungan pengembangan, pengujian, dan produksi. Apidog memudahkan pengiriman permintaan ke berbagai lingkungan—Anda hanya perlu mengeklik dan memilih lingkungan yang diinginkan di sudut kanan atas antarmuka.Lingkungan Apidog terdiri dari dua elemen inti:1.
Base URL: Mempertahankan tujuan pengiriman permintaan.
2.
Variabel: Kelompok variabel yang dapat dirujuk dalam permintaan atau skrip.
Membuat Lingkungan#
1
Buka Manajemen LingkunganKlik tombol Manajemen Lingkungan ≡ di sudut kanan atas antarmuka.
2
Buat Lingkungan BaruKlik item terakhir dalam daftar sisi kiri yang berlabel Lingkungan Baru.
3
Konfigurasikan LingkunganMasukkan nama untuk lingkungan baru Anda. Tambahkan Base URL dan variabel. 5
Pilih LingkunganUntuk menggunakan lingkungan baru, pilih lingkungan tersebut dari pemilih lingkungan di sudut kanan atas antarmuka. Tindakan ini menjadikannya lingkungan aktif dan menetapkan semua variabel ke nilai yang ditentukan dalam lingkungan tersebut.
Apidog mempertahankan pemisahan yang jelas antara lingkungan dan Base URL. Lingkungan merepresentasikan berbagai tahap deployment (pengembangan, pengujian, produksi), sedangkan Base URL dikonfigurasikan dalam setiap lingkungan. Pemisahan ini memberikan fleksibilitas saat mengelola beberapa layanan atau micro-service di berbagai lingkungan.Sebaliknya, lingkungan Apidog secara langsung mencerminkan lingkungan nyata seperti pengembangan, pengujian, dan produksi, bukan memperlakukan setiap Base URL sebagai satu lingkungan tersendiri.
Base URL#
Base URL adalah fitur utama dalam lingkungan Apidog. Di Apidog, path endpoint biasanya dimulai dengan garis miring (/) dan tidak menyertakan Base URL. Saat mengirim permintaan, Apidog menambahkan Base URL tujuan di depan path endpoint.Format Base URL yang terstandardisasi dimulai dengan protokol dan tidak menyertakan garis miring penutup (/).Setiap Base URL berkaitan dengan Module tertentu. Dalam sebagian besar kasus, sebuah endpoint akan menggunakan Base URL dari modulnya untuk mengirim permintaan.Misalnya, jika Base URL dari modul default untuk lingkungan Production adalah http://abc.com/v1 dan path endpoint Anda adalah /pet, maka saat Anda mengirim permintaan di lingkungan Production, URL permintaan aktual yang dikirim adalah:Jika path endpoint dimulai dengan http:// atau https://, Base URL tidak akan ditambahkan. Namun, melakukan hardcode URL lengkap dalam endpoint umumnya tidak disarankan.
Di Apidog, terdapat variabel lingkungan khusus bernama BASE_URL yang menyimpan Base URL untuk "Default Server" dari lingkungan saat ini. Secara umum, penggunaan variabel ini secara langsung tidak disarankan.Disarankan: Gunakan pm.request.getBaseUrl() untuk mengambil Base URL dari endpoint saat ini.
Hindari: Menggunakan pm.environment.get('BASE_URL'), karena mungkin tidak menangkap Base URL dengan benar jika endpoint tidak menempati "Default Server".
BASE_URL, variabel tersebut akan menggantikan BASE_URL bawaan sistem.Catatan: Skrip tidak dapat mengubah konfigurasi Base URL itu sendiri. Perintah pm.environment.set('BASE_URL', 'My_url') hanya akan membuat variabel bernama BASE_URL. Menggunakan Beberapa Base URL dengan Modul#
Jika endpoint proyek Anda perlu terhubung ke beberapa Base URL (misalnya, microservices), cara terbaik untuk mengelolanya adalah dengan menggunakan beberapa Modules di Apidog.Endpoint pengguna: https://user.example.com
Endpoint pesanan: https://order.example.com
Endpoint produk: https://product.example.com
1
Buat ModulDi bagian atas pohon folder API, tambahkan beberapa modul yang sesuai dengan layanan Anda. 2
Konfigurasikan Base URLDi Manajemen Lingkungan, Anda akan melihat bidang untuk menetapkan Base URL bagi setiap modul. Masukkan URL untuk setiap lingkungan dan klik Simpan. 3
Tetapkan Base URL ModulDalam pengaturan folder root suatu modul, pilih Base URL mana yang harus digunakan oleh endpoint modul tersebut.Pengaturan Default: Menggunakan Base URL pertama yang tercantum untuk modul tersebut (Disarankan).
Tentukan Secara Manual: Pilih Base URL lain secara manual. (Tidak disarankan untuk sebagian besar kasus).
4
PewarisanDi subfolder atau endpoint individual, Anda juga dapat menentukan Base URL.Warisi dari Induk: Mengikuti folder induk (Default).
Tentukan Secara Manual: Timpa untuk item tertentu.
5
Kirim PermintaanSetelah disiapkan, cukup klik Kirim. Apidog menentukan Base URL yang tepat berdasarkan pengaturan modul dan lingkungan.
Menambahkan Variabel Lingkungan#
Saat Anda menambahkan variabel ke suatu lingkungan, Anda dapat menentukan dua nilai:Nilai awal: Dibagikan dengan tim.
Nilai saat ini: Disimpan secara lokal di komputer Anda.
Beralih Antarlingkungan#
Apidog menampilkan lingkungan saat ini pada pemilih lingkungan di sudut kanan atas workbench. Setiap kali Anda membuat permintaan atau menjalankan skrip, Apidog akan menggunakan nilai saat ini untuk semua variabel dalam lingkungan yang dipilih.Untuk beralih, cukup pilih lingkungan lain dari pemilih.Endpoint: Spesifikasi API (path biasanya dimulai dengan /).
Permintaan: Permintaan HTTP aktual yang dikirim (mencakup URL lengkap).
{{Base_url}} jika diperlukan.Migrasi Lingkungan#
Di Apidog, Nilai awal variabel disinkronkan dalam tim, sedangkan Nilai saat ini hanya disimpan secara lokal. Ini berarti nilai saat ini tidak terbawa ke perangkat lain.Apidog menyediakan fungsionalitas ekspor/impor untuk memigrasikan lingkungan (termasuk nilai saat ini lokal) antarperangkat.1
EksporDi Manajemen Lingkungan, arahkan kursor ke ... di sebelah lingkungan, klik Ekspor untuk mendapatkan file JSON. 2
ImporDi komputer tujuan, buka Manajemen Lingkungan, arahkan kursor ke ..., klik Impor, dan pilih file JSON.
Cakupan Visibilitas Lingkungan#
Anda dapat membuat Lingkungan Privat untuk variabel yang tidak ingin Anda bagikan.Di sudut kanan atas pengaturan lingkungan, tetapkan cakupan visibilitas.Dibagikan: Terlihat oleh tim (Default).
Privat: Hanya terlihat oleh Anda.
Lingkungan Privat berbagi Daftar layanan (Base URL) yang sama dengan lingkungan lain. Menambahkan atau menghapus layanan dalam Lingkungan Privat akan memengaruhi semua lingkungan secara bersamaan.
FAQ#
Bagaimana cara mendapatkan Base URL layanan dalam skrip kustom?Gunakan pm.request.getBaseUrl() untuk mengambil Base URL dari endpoint saat ini. 
