Cara menggunakan Postman (Menguji API sederhana dengan Postman)

Melanjutkan tutorial pada postingan sebelumnya yaitu "Cara menginstal Postman dan cara menggunakan Postman", pada tutorial ini saya akan membahas bagaimana cara menggunakan Postman untuk melakukan pengujian terhadap sebuah API (Application Programing Interface) sederhana.

Untuk melakukan sebuah pengujian terhadap API, tentunya mesti ada APInya terlebih dahulu. Jadi pertama-tama saya akan membuat API sederhana menggunakan bahasa pemrograman PHP (PHP: Hypertext Prepocessor).

  1. Buat sebuah file baru pada direktori root webserver dengan nama: contoh-api-sederhana.php
  2. Kemudian ketikan kode PHP berikut ke dalam file contoh-api-sederhana.php
     
    <?php
    /**  
     * Contoh API Sederhana
     * irul @ 20171102
     */
    $method = $_SERVER['REQUEST_METHOD'];
    switch ($method) {
        case 'GET':
            echo "$method: Contoh API Sederhana";
            break;
        case 'POST':
        case 'PUT':
        case 'DELETE':
            $json = file_get_contents('php://input');
            $data = json_decode($json);
            echo "$method: " . $data->nama;
            break;
        default:
            echo "Method not defined!";
    }
    ?>

Pada file contoh-api-sederhana.php di atas saya mendefinisikan satu (1) buah API dengan empat (4) Http Request Method yang berbeda, yaitu: GET, POST, PUT, dan DELETE. Berikut ini daftar method dan alamat url yang nanti akan kita uji menggunakan Postman:

  • GET => /contoh-api-sederhana.php
  • POST => /contoh-api-sederhana.php
  • PUT => /contoh-api-sederhana.php
  • DELETE => /contoh-api-sederhana.php

Sebelum menggunakan Postman, kita dapat menguji salah satu API di atas menggunakan browser. Memangnya bisa? Ya, bisa! Kalo kita lihat lagi pada daftar API di atas, salah satunya ada yang menggunakan method GET. Secara default browser akan mengirimkan data ke server menggunakan method GET, jadi kita dapat menguji API yang menggunakan method GET di atas menggunakan browser.

Bukalah sebuah browser (Chrome, Firefox, atau yang lainnya) lalu ketik alamat url berikut: http://localhost/contoh-api-sederhana.php. Jika kode yang saya dan Anda tulis benar, maka pada halaman browser akan tampil tulisan "GET: Contoh API Sederhana" seperti gambar di bawah ini.

Contoh API Sederhana

Cara menggunakan Postman

Baik, kita lanjut pengujian API menggunakan Postman. Teman-teman sekalian dapat mengikuti langkah-langkah berikut, yang saya jabarkan berdasarkan masing method. Pertama-tama silahkan buka aplikasi Postman.

Pengujian API dengan method: GET

  1. Pilih method GET di sebelah kolom alamat url
  2. Kemudian pada kolom alamat url isi dengan: http://localhost/contoh-api-sederhana.php
  3. Klik tombol Send

Postman: Pengujian API menggunakan method GET

Dari pengujian dengan method GET, hasil yang kita dapatkan seharusnya sama dengan pengujian yang kita lakukan sebelumnya, dimana kita menggunakan browser yaitu: "GET: Contoh API Sederhana".

Pengujian API dengan method: POST

Masih pada halaman Postman yang aktif,

  1. Ganti method GET dengan method POST
  2. Biarkan alamat url (tidak perlu diganti)
  3. Klik pada tab Body, lalu pilih tab raw
  4. Isi kontennya dengan json object: {"nama":"irul"}
  5. Klik tombol Send

Pada method POST ini, kita mengirimkan parameter berupa data raw (data mentah) yaitu string dengan format json object. Method ini biasanya digunakan untuk request menambah data baru. Hasilnya dapat dilihat pada gambar di bawah ini.

Postman: Pengujian API menggunakan method POST

Pengujian API dengan method: PUT

Masih pada halaman Postman yang aktif,

  1. Ganti method POST dengan method PUT
  2. Lainnya biarkan saja tidak perlu dirubah (masih sama seperti POST)
  3. Klik tombol Send

Pada pengujian dengan method PUT ini, kita mengirimkan parameter yang sama seperti ketika menggunakan method POST yaitu berupa data raw dengan format json object. Method PUT biasanya digunakan ketika ada data yang perlu diubah. Lihat gambar di bawah ini.

Postman: Pengujian API menggunakan method PUT

Pengujian API dengan method: DELETE

Masih disini aja, ups.. Masih di tampilan Postman yang sebelumnya,

  1. Sekarang ganti method PUT dengan method DELETE
  2. Yang lain biarkan saja
  3. Klik tombol Send

Method terakhir yang kita uji adalah DELETE. Kita masih mengirimkan parameter yang sama seperti pada method PUT dan method POST. Method DELETE ini, sesuai namanya, digunakan ketika ada data yang perlu dihapus. Hasil atau respon dapat dilihat pada gambar di bawah ini.

Postman: Pengujian API menggunakan method DELETE

Demikianlah pembahasan mengenai pengujian API sederhana menggunakan Postman. Karena API yang diuji sangat sederhana maka hasilnya pun sederhana, hanya menampilkan kembali nilai atau parameter yang dikirim. Namun harapan saya semoga teman-teman yang membaca tulisan ini memahami apa yang telah saya sampaikan dan mudah-mudahan dapat mengembangkannya.

Mohon maaf apabila ada kekurangan atau informasi yang kurang benar pada tutorial ini.

Categories