RESTful API: Aturan Penulisan Endpoint API yang Sesuai Standar

API-Mu Mencerminkan Kualitasmu

Membuat Backend API (seperti dengan Node.js/Express) itu mudah. Tapi membuat API yang rapi, mudah dibaca, dan mengikuti standar global membutuhkan kedisiplinan. Jika seorang Senior Developer melihat kodemu dan URL-nya berantakan, mereka akan langsung tahu bahwa kamu masih pemula.

Standar Arsitektur REST

REST (Representational State Transfer) adalah gaya arsitektur yang memaksa kita menggunakan HTTP Methods (GET, POST, PUT, DELETE) sebagai kata kerja, dan menjadikan URL (*Endpoint*) murni hanya sebagai Kata Benda (Resource).

1. URL Harus Berupa Kata Benda (Nouns), Bukan Kata Kerja

Karena aksi "mengambil" atau "menghapus" sudah diwakilkan oleh HTTP Method, jangan tulis kata kerjanya di URL!

• BURUK: GET /getUsers, POST /buatProduk, POST /hapusUser/1
• BAIK: GET /users, POST /products, DELETE /users/1

2. Gunakan Nama Jamak (Plurals) Secara Konsisten

Jangan campur aduk nama tunggal dan jamak. Gunakan format jamak (tambah 's' dalam bahasa Inggris) untuk semua koleksi data agar seragam.

• BURUK: GET /user, GET /product
• BAIK: GET /users, GET /products

3. Bersarang (Nesting) Sesuai Hierarki

Jika sebuah data dimiliki oleh data lain, tunjukkan di URL secara logis. Misalnya, kamu ingin mengambil daftar artikel (posts) yang ditulis oleh User dengan ID nomor 5.

• URL RESTful: GET /users/5/posts

Ini dibaca: Ambilkan saya data posts, yang dimiliki oleh user nomor 5.

4. Gunakan Query String untuk Filter dan Sorting

Jangan membuat *endpoint* baru untuk setiap pencarian. Gunakan parameter tanda tanya (?) di belakang URL.

• BURUK: GET /users/active atau GET /users/sort-by-age
• BAIK: GET /users?status=active&sort=age

5. Jangan Gunakan Huruf Besar (Gunakan Kebab-Case)

Jika URL-mu terdiri dari dua kata, gabungkan dengan tanda setrip (kebab-case), bukan CamelCase (huruf besar di tengah) atau Snake_Case.

• BURUK: GET /userProfiles atau GET /user_profiles
• BAIK: GET /user-profiles

Kesimpulan

Mendesain API itu seperti mendesain rambu lalu lintas. Harus jelas, mudah ditebak, dan tidak membingungkan Frontend Developer yang akan memakainya. Biasakan merancang URL Endpoints di atas kertas sebelum kamu mulai menulis logika backend-nya.