Sebagai developer, menguji API adalah bagian tak terpisahkan dari proses pengembangan. Di sinilah Postman berperan sebagai tool yang sangat powerful dan user-friendly untuk menguji, mengembangkan, dan mendokumentasikan API. Dengan Postman, kamu bisa mengirim berbagai jenis request HTTP, memeriksa response, dan mengotomatisasi pengujian.
Panduan ini akan membawa kamu melalui langkah-langkah dasar hingga menengah dalam menggunakan Postman untuk testing API.
1. Instalasi dan Pengenalan Antarmuka Postman
Sebelum mulai, pastikan kamu sudah menginstal aplikasi Postman. Jika belum, kamu bisa mengunduhnya dari website resmi Postman. Postman tersedia untuk Windows, macOS, dan Linux.
Setelah terinstal dan dibuka, kamu akan melihat antarmuka utama Postman:
-
Sidebar Kiri: Berisi riwayat (History) request kamu, Collections (kumpulan request), dan Environments (variabel lingkungan).
-
Area Kerja Utama: Di sinilah kamu akan membuat dan mengelola request HTTP.
-
Header Bar Atas: Berisi opsi untuk membuat request baru, Collection baru, Environment baru, dll.
-
Tab Request: Setiap request yang kamu buka akan berada di tab terpisah, mirip browser.
2. Membuat Request HTTP Sederhana (GET)
Mari mulai dengan request HTTP yang paling dasar: GET, yang digunakan untuk mengambil data dari server.
-
Buka Tab Request Baru: Klik ikon
+
di sebelah tab request yang sudah ada, atau klikFile > New Tab
. -
Pilih Metode HTTP: Di dropdown menu, pilih
GET
. -
Masukkan URL Endpoint: Di kolom URL, masukkan endpoint API yang ingin kamu uji.
-
Contoh:
https://jsonplaceholder.typicode.com/posts/1
(ini adalah public API untuk contoh).
-
-
Kirim Request: Klik tombol biru "Send".
-
Lihat Response: Di bagian bawah, kamu akan melihat area response yang menampilkan:
-
Status Code: (e.g.,
200 OK
berarti sukses,404 Not Found
,500 Internal Server Error
). -
Time: Waktu yang dibutuhkan untuk mendapatkan response.
-
Size: Ukuran response.
-
Body: Data yang dikembalikan oleh server (biasanya dalam format JSON atau XML).
-
Headers: Informasi header dari response.
-
3. Membuat Request HTTP dengan Data (POST, PUT, DELETE)
Selain GET, kamu juga akan sering menggunakan metode lain untuk mengirim atau memodifikasi data.
A. POST Request (Mengirim Data Baru)
Untuk mengirim data baru ke server.
-
Pilih Metode: Pilih
POST
dari dropdown. -
Masukkan URL Endpoint: Misalnya,
https://jsonplaceholder.typicode.com/posts
-
Tambahkan Data (Body):
-
Pilih tab "Body" di bawah URL.
-
Pilih opsi
raw
dan di dropdown sebelahnya, pilihJSON
. -
Masukkan data JSON yang ingin kamu kirim di text area.
JSON{ "title": "foo", "body": "bar", "userId": 1 }
-
-
Kirim Request: Klik "Send".
-
Lihat Response: Server biasanya akan mengembalikan data yang telah dibuat, beserta ID unik.
B. PUT Request (Memperbarui Data)
Untuk memperbarui data yang sudah ada.
-
Pilih Metode: Pilih
PUT
. -
Masukkan URL Endpoint: Sertakan ID resource yang ingin diperbarui, misalnya
https://jsonplaceholder.typicode.com/posts/1
(untuk mengupdate post dengan ID 1). -
Tambahkan Data (Body): Sama seperti POST, pilih
JSONraw
danJSON
, lalu masukkan data yang diperbarui.{ "id": 1, "title": "foo updated", "body": "bar updated", "userId": 1 }
-
Kirim Request dan Periksa Response.
C. DELETE Request (Menghapus Data)
Untuk menghapus data.
-
Pilih Metode: Pilih
DELETE
. -
Masukkan URL Endpoint: Sertakan ID resource yang ingin dihapus, misalnya
https://jsonplaceholder.typicode.com/posts/1
. -
Kirim Request: Metode DELETE biasanya tidak memerlukan Body.
-
Lihat Response: Server akan mengembalikan status sukses (misalnya
200 OK
atau204 No Content
) jika penghapusan berhasil.
4. Menggunakan Headers, Params, dan Authorization
API seringkali membutuhkan informasi tambahan di request seperti headers (untuk otentikasi atau tipe konten) dan query parameters (untuk filtering atau pagination).
A. Headers
-
Pilih tab "Headers" di bawah URL.
-
Masukkan key dan value. Contoh:
-
Content-Type
:application/json
(sering otomatis terisi saat memilihraw
JSON di Body). -
Authorization
:Bearer your_access_token
(untuk otentikasi JWT).
-
B. Params (Query Parameters)
-
Pilih tab "Params" di bawah URL.
-
Masukkan key dan value. Postman akan secara otomatis menambahkan ini ke URL setelah tanda
?
dan&
.-
Contoh: Untuk URL
https://jsonplaceholder.typicode.com/posts?userId=1
-
Key:
userId
-
Value:
1
-
-
C. Authorization
-
Pilih tab "Authorization" di bawah URL.
-
Pilih tipe otentikasi (misalnya
Bearer Token
,Basic Auth
,OAuth 2.0
). -
Isi kredensial yang dibutuhkan. Ini sangat penting untuk API yang membutuhkan login.
5. Mengatur Collections dan Environments
Fitur ini sangat krusial untuk mengelola request secara terorganisir dan bekerja dengan berbagai lingkungan (development, staging, production).
A. Collections (Kumpulan Request)
-
Apa Itu: Folder untuk mengelompokkan request yang saling terkait (misalnya, semua request untuk satu proyek API, atau semua request untuk API user management).
-
Cara Membuat:
-
Di Sidebar kiri, klik tombol "New" atau ikon
+
di sebelah "Collections". -
Pilih "Collection". Beri nama (e.g., "My E-commerce API").
-
-
Menyimpan Request ke Collection:
-
Setelah membuat atau mengedit request, klik tombol "Save" di dekat tombol "Send".
-
Pilih Collection yang sesuai dan beri nama request.
-
-
Manfaat: Mengorganisir request, menjalankan beberapa request sekaligus (Collection Runner), membuat dokumentasi.
B. Environments (Variabel Lingkungan)
-
Sekumpulan variabel yang bisa kamu gunakan di berbagai request. Ini sangat berguna untuk menyimpan URL dasar API (
{{baseUrl}}
), access token ({{accessToken}}
), atau API key yang berbeda antara lingkungan development, staging, dan production. -
Cara Membuat:
-
Di Sidebar kiri, klik ikon "Environments" (ikon mata) di bagian atas, lalu klik "Add".
-
Beri nama Environment (e.g., "Development API").
-
Tambahkan variabel:
-
Variable:
baseUrl
-
Initial Value:
http://localhost:3000/api
(untuk development) -
Current Value: (sama dengan Initial Value, atau bisa beda untuk sementara)
-
-
Klik "Save".
-
-
Cara Menggunakan:
-
Pilih Environment yang aktif dari dropdown di sudut kanan atas Postman.
-
Dalam URL, headers, atau body request, gunakan
{{variableName}}
.-
Contoh URL:
{{baseUrl}}/posts/1
-
-
-
Manfaat: Fleksibilitas, menghindari pengulangan, menjaga keamanan (tidak perlu hardcode token).
6. Menggunakan Tests dan Pre-request Scripts
Ini adalah fitur lanjutan yang membuat Postman sangat kuat untuk automation testing.
A. Pre-request Scripts
-
Apa Itu: Kode JavaScript yang berjalan sebelum request utama dikirim.
-
Penggunaan: Untuk menyiapkan data, menghasilkan timestamp, atau mendapatkan access token baru (misalnya dari login API) dan menyimpannya sebagai variabel environment sebelum request utama dijalankan.
-
Cara Menggunakan:
-
Pilih tab "Pre-request Script" di bawah URL.
-
Tulis kode JavaScript.
JavaScript// Contoh: Mengatur header Authorization secara dinamis pm.request.headers.add({ key: 'Authorization', value: `Bearer {{accessToken}}` }); // Contoh: Mengatur variabel environment pm.environment.set("currentTimestamp", Date.now());
-
B. Tests
-
Apa Itu: Kode JavaScript yang berjalan setelah response diterima. Digunakan untuk memverifikasi response API (misalnya, status code benar, data yang dikembalikan sesuai harapan).
-
Penggunaan: Mengotomatisasi pengujian, memastikan API berfungsi sesuai spesifikasi.
-
Cara Menggunakan:
-
Pilih tab "Tests" di bawah URL.
-
Tulis kode JavaScript menggunakan objek
JavaScriptpm.test()
danpm.response
. Postman menyediakan banyak snippets siap pakai di sidebar kanan tab Tests.// Contoh 1: Memverifikasi status code adalah 200 OK pm.test("Status code is 200 OK", function () { pm.response.to.have.status(200); }); // Contoh 2: Memverifikasi response body mengandung properti tertentu pm.test("Response has 'id' property", function () { var jsonData = pm.response.json(); pm.expect(jsonData).to.have.property('id'); }); // Contoh 3: Memverifikasi nilai properti tertentu pm.test("Response title is 'foo updated'", function () { var jsonData = pm.response.json(); pm.expect(jsonData.title).to.eql("foo updated"); }); // Contoh 4: Menyimpan data dari response ke variabel environment pm.environment.set("createdPostId", pm.response.json().id);
-
Setelah mengirim request, hasil test akan muncul di tab "Test Results" di area response.
-
7. Menggunakan Collection Runner
Untuk menjalankan serangkaian request dari Collection secara berurutan, seringkali dengan skenario pengujian tertentu.
-
Buka Collection Runner:
-
Dari Sidebar, pilih Collection kamu, lalu klik ikon panah
>
di sampingnya, kemudian klik "Run Collection". -
Atau, klik tombol "Runner" di bagian bawah Sidebar kiri.
-
-
Konfigurasi Lari:
-
Pilih Collection yang ingin dijalankan.
-
Pilih Environment yang akan digunakan.
-
Atur jumlah iterasi (berapa kali Collection akan dijalankan).
-
Atur delay antar request (jika perlu).
-
-
Mulai Lari: Klik "Run [Nama Collection]".
-
Lihat Hasil: Postman akan menampilkan laporan hasil setiap request dan test yang dijalankan, menunjukkan mana yang passed dan failed.
Kesimpulan
Postman adalah tool yang sangat fundamental dan serbaguna bagi setiap web developer dan QA engineer yang bekerja dengan API. Dengan menguasai fitur-fitur dasarnya hingga kemampuan testing otomatis melalui scripts, kamu bisa meningkatkan efisiensi pengembangan, memastikan kualitas API, dan mempercepat workflow kerjamu. Selamat mencoba dan eksplorasi lebih jauh!
0 Komentar
Artikel Terkait
