Express Router וניתוב: routes, פרמטרים ו-prefixes

ניתוב ב-Express ממפה method של HTTP ונתיב לפונקציית handler: ‏app.get('/users', handler) עונה לבקשות GET ל-/users, ו-app.post(), app.put() ו-app.delete() עושים את אותו הדבר לשאר ה-methods. קטע שמתחיל בנקודתיים, כמו ב-/users/:id, הוא פרמטר של route, והערך שלו נכנס ל-req.params. כדי לשמור על סדר באפליקציה שגדלה, שימו routes קשורים ב-express.Router() וחברו אותו תחת prefix עם app.use('/api', router).

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

const users = [
    { id: 1, name: 'Ada' },
    { id: 2, name: 'Linus' },
];
let nextId = 3;

app.get('/users', (req, res) => {
    res.json(users);
});

// GET /users/2
app.get('/users/:id', (req, res) => {
    const user = users.find((u) => u.id === Number(req.params.id));
    if (!user) return res.status(404).json({ error: 'User not found' });
    res.json(user);
});

app.post('/users', (req, res) => {
    const user = { id: nextId++, name: req.body.name };
    users.push(user);
    res.status(201).json(user);
});

app.delete('/users/:id', (req, res) => {
    const index = users.findIndex((u) => u.id === Number(req.params.id));
    if (index === -1) return res.status(404).json({ error: 'User not found' });
    users.splice(index, 1);
    res.status(204).end();
});

app.listen(3000);

GET /users/2 עונה {"id":2,"name":"Linus"}. פרמטרים של route הם תמיד מחרוזות, ולכן ה-handler משווה עם Number(req.params.id). שלחו POST /users עם הגוף {"name": "Grace"} כדי לקבל 201, ואז DELETE /users/1 ו-GET /users כדי לראות את הרשימה משתנה.

express.Router() עם prefix

router הוא מיני אפליקציה עם routes ו-middleware משלו. הנתיבים שלו יחסיים: route שנכתב כ-/:id בתוך router שמחובר ב-/api/books עונה ל-/api/books/:id. בפרויקט אמיתי כל router יושב בקובץ משלו ומסתיים ב-module.exports = router.

const express = require('express');

// routes/books.js
const books = express.Router();
const list = [{ id: 1, title: 'Dune' }];

books.get('/', (req, res) => {
    res.json(list);
});

books
    .route('/:id')
    .get((req, res) => {
        res.json(list.find((b) => b.id === Number(req.params.id)) ?? null);
    })
    .put((req, res) => {
        res.json({ updated: req.params.id });
    })
    .delete((req, res) => {
        res.json({ deleted: req.params.id });
    });

// server.js
const app = express();
app.use('/api/books', books);

// GET /api/books/1
app.listen(3000);

GET /api/books/1 מחזיר {"id":1,"title":"Dune"}. ‏router.route('/:id') כותב את הנתיב פעם אחת ומשרשר handler אחד לכל method; שלחו PUT /api/books/1 ותקבלו {"updated":"1"}. שנו את נתיב החיבור ל-/v2/books ואותו router יענה שם במקום.

סדר ה-routes: ההתאמה הראשונה מנצחת

Express מנסה routes לפי הסדר שבו רשמתם אותם ועוצר בראשון ששולח תשובה. route עם פרמטר תופס כל דבר במיקום שלו, כך שנתיב קבוע שנרשם אחריו לא מגיעים אליו אף פעם:

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

app.get('/users/:id', (req, res) => {
    res.json({ route: '/users/:id', id: req.params.id });
});

app.get('/users/new', (req, res) => {
    res.json({ route: '/users/new' });
});

// Runs only when no route above answered.
app.use((req, res) => {
    res.status(404).json({ error: `Cannot ${req.method} ${req.path}` });
});

// GET /users/new
app.listen(3000);

GET /users/new עונה {"route":"/users/:id","id":"new"}: ה-route עם הפרמטר נרשם ראשון ותפס את הבקשה. העבירו את ה-route של /users/new אל מעל /users/:id והריצו שוב כדי לקבל {"route":"/users/new"}. אחר כך שלחו GET /books כדי להגיע ל-handler של ה-404 בתחתית.

ה-handler של 404

Express עונה לבקשה שלא נמצאה לה התאמה בדף HTML משלו, Cannot GET /books. ב-API בדרך כלל רוצים JSON, אז הוסיפו app.use() בלי נתיב בתור ה-route האחרון ממש, כמו בבלוק שלמעלה. הוא רץ רק כשכל route לפניו העביר את הבקשה הלאה. שגיאות שנזרקות מ-handlers הן מקרה אחר עם handler משלהן שמקבל ארבעה ארגומנטים, ומוסברות ב-טיפול בשגיאות ב-Express.

נתיבי routes ב-Express 5

Express 5 שינה את התחביר של הנתיבים, ורוב הקטעים ברשת כתובים ל-Express 4:

* לבד או ? אחרי פרמטר זורקים TypeError כשה-route נרשם, כך שהאפליקציה לא עולה.

טעויות נפוצות

לרשום את ה-handler של 404 ראשון. app.use() בלי נתיב תואם לכל דבר, כך שכל בקשה מקבלת 404. השאירו אותו בתחתית.

לשכוח שה-prefix מוסר. בתוך router שמחובר ב-/api, ‏req.path לא כולל את /api. השתמשו ב-req.originalUrl כשאתם צריכים את הנתיב המלא.

השוואה של פרמטר למספר. req.params.id === 1 תמיד false, כי req.params.id הוא המחרוזת '1'.