req.params, req.query dan req.body di Express

Di Express, req.params berisi nilai segmen bernama di path route (/users/:id menghasilkan req.params.id), req.query berisi query string setelah ? (/search?q=node menghasilkan req.query.q), dan req.body berisi data yang dikirim di body request. req.params dan req.query terisi di setiap request, tetapi req.body tetap undefined sampai parser body seperti app.use(express.json()) membacanya. Nilai di params dan query selalu berupa string.

const express = require('express');
const app = express();
app.use(express.json());

app.get('/users/:userId/posts', (req, res) => {
    res.json({ params: req.params, query: req.query });
});

app.post('/users/:userId/posts', (req, res) => {
    res.status(201).json({ params: req.params, body: req.body });
});

// GET /users/7/posts?sort=new&limit=2
app.listen(3000);

Request pertama menjawab {"params":{"userId":"7"},"query":{"sort":"new","limit":"2"}}. Perhatikan tanda kutipnya: 7 dan 2 adalah string, jadi ubah dengan Number() sebelum kamu menghitung atau membandingkan dengan angka. Sekarang ganti method-nya ke POST, biarkan path-nya /users/7/posts, dan kirim body {"title": "Hello", "draft": true}: jawabannya 201 dengan "body":{"title":"Hello","draft":true}, di mana true adalah boolean sungguhan karena berasal dari JSON.

req.params vs req.query vs req.body

Sebuah route bisa punya beberapa parameter, dan setiap nama menjadi key di req.params: /teams/:teamId/members/:memberId memberikan kedua id. Tanda hubung atau titik juga memisahkannya, jadi /flights/:from-:to mengubah /flights/LAX-SFO menjadi { from: 'LAX', to: 'SFO' }.

req.query dengan key berulang dan yang tidak ada

Key yang muncul dua kali menjadi array, dan key yang tidak ada bernilai undefined, jadi beri opsinya nilai default:

const express = require('express');
const app = express();

app.get('/products', (req, res) => {
    const page = Number(req.query.page ?? 1);
    const tags = [].concat(req.query.tag ?? []);
    res.json({ page, tags, raw: req.query });
});

// GET /products?tag=red&tag=sale
app.listen(3000);

Jawabannya {"page":1,"tags":["red","sale"],"raw":{"tag":["red","sale"]}}. Kirim GET /products?tag=red&page=3 dan tags tetap array, ["red"], karena [].concat() mengubah satu string atau array menjadi array. Express 5 mem-parse query string dengan parser sederhana milik Node, jadi ?filter[size]=m menghasilkan key "filter[size]", bukan object bersarang; Express 4 membuatnya bersarang.

req.body butuh express.json()

Node mengirim body sebagai stream byte. express.json() membacanya, mem-parse-nya, dan mengisi req.body, tetapi hanya saat request punya Content-Type: application/json. Form HTML mengirim application/x-www-form-urlencoded, yang butuh express.urlencoded().

const express = require('express');
const app = express();
app.use(express.json());

app.post('/signup', (req, res) => {
    const { email, name } = req.body ?? {};
    if (!email) {
        return res.status(400).json({ error: 'email is required' });
    }
    res.status(201).json({ email, name: name ?? 'anonymous' });
});

app.get('/', (req, res) => {
    res.send('Send POST /signup with a JSON body');
});

app.listen(3000);

Kirim POST /signup dengan body {"email": "ada@example.com"} dan kamu mendapat 201 dengan {"email":"ada@example.com","name":"anonymous"}. Kirim body kosong dan kamu mendapat 400. ?? {} itu penting: tanpanya, men-destructure undefined melempar TypeError di setiap request yang tidak punya body JSON. Untuk validasi bentuk dan tipe yang sungguhan, pakai library schema seperti zod.

req.headers dan req.get()

req.headers adalah object berisi semua header request, dengan nama huruf kecil. req.get(name) membaca satu header dan mengabaikan huruf besar kecil, jadi req.get('Content-Type') dan req.get('content-type') mengembalikan nilai yang sama. Beberapa property lain yang akan kamu pakai:

const express = require('express');
const app = express();

app.get('/whoami', (req, res) => {
    res.json({
        method: req.method,
        path: req.path,
        originalUrl: req.originalUrl,
        agent: req.get('User-Agent') ?? null,
        token: req.get('authorization') ?? null,
    });
});

// GET /whoami?debug=1
app.listen(3000);

path bernilai /whoami dan originalUrl bernilai /whoami?debug=1. Tambahkan header Authorization: Bearer abc di request bar lalu kirim lagi: token menjadi "Bearer abc". Di dalam router yang dipasang dengan app.use('/api', router), req.path kehilangan prefix /api sedangkan req.originalUrl tetap menyimpannya (routing Express menjelaskan cara memasang router).

Kesalahan umum

Membaca req.body di request GET. Browser dan sebagian besar client tidak mengirim body bersama GET. Taruh opsi GET di query string.

Mengecek flag query sebagai truthy. ?admin=false menghasilkan string 'false', yang truthy, jadi if (req.query.admin) lolos. Bandingkan string-nya: req.query.admin === 'true'.

Mengirim JSON tanpa header. Client yang mengirim JSON sebagai text/plain mendapat req.body === undefined. Atur Content-Type: application/json di client.