Nafies Luthfi

Life will always feel wonderful if we always think positively.

Mengatur Environment Variable pada POSTMAN

Bismillahirrahmanirrahim.

Ketika kita mengembangkan API Endpoint untuk dikonsumsi berbagai platform sistem, salah satu alat bantunya adalah POSTMAN. POSTMAN adalah alat bantu untuk menguji hasil atau output dari API Endpoint dari sebuah server back-end. Baik Endpoint tersebut berasal dari localhost (saat development), maupun di server online.

Jika kita ingin menguji endpoint-endpoint API yang sudah dibuat, kita harus mengisi URL yang sesuai dengan lingkungan server yang diuji, yaitu di localhost dan di server online. Misalnya di localhost base URLnya: http://localhost/dompet/public, sedangkan di server online, pasti base URLnya berbeda, misalnya: http://dompet.nafies.id.

Ketika tahap development kita tes endpoint di localhost, dengan URL localhost, ketika tes endpoint di server online, kita ubah URL nya jadi domain di server online. Ketika lanjut development, URL domain server online diubah lagi menjadi localhost.

Kalau hanya 1 atau 5 endpoint saja tidak masalah kita gonta-ganti URL seperti itu. Tapi kalau endpointnya ada 20 bagaimana? Kalau ada 50 endpoint bagaimana? Apakah harus mengganti semua URL? Atau sebagai alternatif, kita buat endpoint duplikat, yang satu untuk locahost yang satu untuk online? Apakah begitu? Ternyata tidak perlu. Ada satu fitur di POSTMAN yang bernama Environment.

Fitur Environment

Fitur Environment ini dapat kita gunakan untuk membuat variabel dengan nilai yang berbeda sesuai dengan lingkungan (environment) yang ingin diuji coba. Manfaatnya, kita tidak repot lagi mengganti-ganti URL atau nilai-nilai apapun untuk menguji API endpoint yang ada di localhost dan server online.

Membuat Environment Variable

Langsung saja, misal kita perlu uji coba project Dompet pada dua lingkungan server, localhost dan server online. Maka kita membuat dua environment :

  1. dompet-local, yaitu environment untuk mencoba API di localhost.
  2. dompet-staging, yaitu environment untuk mencoba API di server staging (atau server demo).

Dari dua environment itu, kita akan membuat variabel dan nilai sesuai dengan pengaturan masing-masing server. Caranya :

POSTMAN Environment

  1. Klik tombol elips disamping environment, lalu klik Add
  2. Isi nama environment (misal: dompet-local)
  3. Isi nama variabel dan nilainya (misal: base_url = http://localhost/lv/2018/dompet/public) Create Environment
  4. Tambah nama variable dan nilainya sesuai kebutuhan
  5. Klik Add
  6. Environment pertama (dompet-local) sudah jadi Created Environment
  7. Klik Add (jika masih berada pada tampilan Manage Environments)
  8. Ulangi langkah dari nomor 2 sampai 5 untuk environment kedua
    • nama environment = dompet-staging
    • variabel base_url = http://dompet.nafies.id Create second Environment
  9. Environment kedua (dompet-staging) sudah jadi Created second Environment

Mengunakan Environment Variable

Untuk menggunakan environment variable yang sudah kita atur tadi, masukkan nama variabel dengan kode {% raw" >}}{{nama_variabel}}{% endraw" >}}, contoh:

  1. Untuk menggunakan variabel base_url pada endpoint URL, kita tambahkan variabel seperti ini
    {% raw" >}}{{base_url}}/api/transactions{% endraw" >}}
  2. Pilih Environment yang kita ingin gunakan.
  3. Untuk menggunakan variabel pada Request Header dan Request Body, caranya juga sama.

Using POSTMAN Environment

Kesimpulan

  1. Dengan bantuan fitur environment ini kita lebih mudah untuk menguji endpoint-endpoint yang ada pada aplikasi yang kita buat di beberapa lingkungan server yang berbeda.
  2. Tidak ada batasan jumlah environment, sehingga kita bisa membuat sesuai kebutuhan, misalnya:
    • dompet-local (untuk development di locahost)
    • dompet-staging (untuk ujicoba pra-produksi)
    • dompet-production (untuk server produksi)
    • dompet-demo (untuk server demo)

Demikian cara mengatur environment variable pada aplikasi POSTMAN, terima kasih.

Referensi Bacaan

http://blog.getpostman.com/2014/02/20/using-variables-inside-postman-and-collection-runner