Membuat REST API dengan Postman

REST API yang baik bukan sekadar mengembalikan JSON. Ia memiliki kontrak URL, method, status code, validasi, autentikasi, dan bentuk error yang konsisten.

Rancang resource, bukan nama aksi

Hindari URL seperti /getTasks atau /deleteTask. Method HTTP sudah menyatakan aksi.

Respons yang dapat diprediksi

{
  "data": {
    "id": 184,
    "title": "Review pull request",
    "status": "open",
    "created_at": "2026-07-26T08:15:00Z"
  }
}

Untuk validasi gagal, kembalikan status 422 dan detail per field. Untuk resource tidak ditemukan gunakan 404, bukan 200 dengan pesan “failed”.

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "Data yang dikirim belum valid.",
    "fields": { "title": ["Title wajib diisi."] }
  }
}

Menguji lewat Postman

1. 1
   Buat environment dengan variabel base_url dan token.
2. 2
   Simpan request dalam collection berdasarkan resource.
3. 3
   Tambahkan test untuk status code, header, dan bentuk JSON.
4. 4
   Jalankan collection dengan Collection Runner atau Newman di CI.

pm.test("Status is 201", () => {
  pm.response.to.have.status(201);
});
pm.test("Response contains an id", () => {
  const json = pm.response.json();
  pm.expect(json.data.id).to.be.a("number");
});

Versioning dan pagination

Gunakan versi ketika perubahan memutus kompatibilitas. Untuk koleksi besar, terapkan cursor pagination agar stabil saat data baru terus masuk. Dokumentasikan limit, filter, sorting, dan contoh error sejak awal.