Satukan Endpoint /Api/V1 dengan Cara Membuat Route Prefix Express Node Js

Cara membuat route prefix Express Node js yaitu memasang express.Router() lewat app.use(‘/api/v1/nama-resource’, router). Path yang ditulis di dalam Router akan menempel otomatis di belakang prefix tersebut. Banyak yang salah menulis prefix lengkap dua kali, sehingga URL jadi /api/v1/users/users.

Kebutuhan Membuat Route Prefix di Express

Prefix mengelompokkan URL di bawah awalan yang sama. Router menyimpan kumpulan route kecil per resource. Middleware memproses request seperti parsing body atau auth sebelum sampai ke handler.

  • Buat folder routes/ agar app.js tidak menampung puluhan definisi route.
  • Aktifkan app.use(express.json()) agar req.body terbaca pada POST dan PUT.
  • Siapkan daftar endpoint target, misalnya GET /api/v1/users, GET /api/v1/users/:id, dan GET /api/v1/products.

Langkah Membuat Route Prefix Express Node Js

  1. Siapkan struktur minimal app.js dan folder routes/users.js serta routes/products.js.
  2. Buat Router users dan products memakai path relatif seperti / dan /:id, bukan path lengkap.
  3. Pasang prefix di app.js dengan app.use(‘/api/v1/users’, usersRouter).
  4. Uji req.params lewat /users/10 dan req.body lewat POST JSON berisi name.
const express = require('express');
const app = express();
app.use(express.json());

const usersRouter = express.Router();
usersRouter.get('/', (req, res) => {
  res.json([{ id: 1, name: 'Andi' }]);
});
usersRouter.get('/:id', (req, res) => {
  res.json({ id: req.params.id });
});
usersRouter.post('/', (req, res) => {
  if (!req.body.name) return res.status(400).json({ message: 'name wajib diisi' });
  res.status(201).json({ id: 2, name: req.body.name });
});

app.use('/api/v1/users', usersRouter);
app.listen(3000);

Tabel Pola Prefix yang Sering Dipakai

Pola Fungsi Contoh URL
/api/v1 Menandai versi API /api/v1/products
/api/v1/admin Menggrup route admin /api/v1/admin/users
/api/v1/users Resource users /api/v1/users/10

Daftarkan route umum sebelum route dinamis seperti /:id. Express membaca app.use dari atas ke bawah, jadi penempatan yang keliru membuat request jatuh ke handler yang salah.

FAQ

Apakah prefix sama dengan nested route?

Tidak persis sama. Prefix menambah awalan URL di app.use, sedangkan nested route mengatur Router di dalam Router.

Bagaimana menambah prefix versi /api/v2?

Buat Router v2 terpisah lalu pasang dengan app.use(‘/api/v2/users’, usersV2Router).

Kenapa route prefix mengembalikan 404?

Umumnya path ditulis ganda atau app.use terdaftar setelah handler 404.