Paginacja

Część sekcji API REST ścieżki Node.js w Coddy. Lekcja 17 z 25.

Lista dziesięciu tysięcy zadań jest zbyt długa na jedną odpowiedź. Podziel ją na strony: klient wysyła zapytanie ?page=2&limit=20 i otrzymuje odpowiedni fragment oraz dane potrzebne do wyświetlenia „Strona 2 z 5”:

{ "items": [ ...books 21 to 40... ], "page": 2, "total": 95, "pages": 5 }

const start = (page - 1) * limit;    // strona 1 zaczyna się od 0
const items = list.slice(start, start + limit);
const pages = Math.ceil(list.length / limit);

Oblicz total po zastosowaniu filtrów, ponieważ ta wartość opisuje listę, o którą poprosił klient. Jeśli w ciągu zapytania nie ma page, użyj wartości 1, a dla limit wartości 10 — przed konwersją: Number(undefined) daje NaN. Następnie odrzucaj kodem 400 każdą wartość, która nie jest liczbą całkowitą z dozwolonego zakresu. Maksymalna wartość limit uniemożliwia klientowi zażądanie wszystkiego naraz.

Wyzwanie

Łatwy

Lista dziesięciu tysięcy zadań jest zbyt długa, by zmieścić ją w jednej odpowiedzi. Wysyłaj listę stronami, aby klient mógł wyświetlić „Strona 1 z 2”.

W routes/tasks.js zmień zwracaną przez trasę listy wartość: zwracaj obiekt zamiast tablicy. Dla GET /api/tasks?limit=2 przy początkowych zadaniach zwróci ona:
```
{
  "items": [
    { "id": 1, "title": "Write the project brief", "done": true, "createdAt": "2026-03-02T09:00:00.000Z" },
    { "id": 2, "title": "Book the meeting room", "done": false, "createdAt": "2026-03-03T10:30:00.000Z" }
  ],
  "page": 1,
  "total": 3,
  "pages": 2
}
```
items zawiera zadania z tej strony, page to numer strony, total to liczba zadań pasujących do filtrów, a pages to liczba stron.
Odczytaj page i limit z ciągu zapytania:
- page to liczba całkowita od 1 wzwyż. Jeśli jej nie podano, użyj 1.
- limit to liczba całkowita od 1 do 50. Jeśli jej nie podano, użyj 10.
Użyj wartości domyślnej przed konwersją, ponieważ Number(undefined) daje NaN. Każda inna wartość (page=0, page=abc, page=1.5, limit=0, limit=51) zwraca status 400; w przypadku nieprawidłowego limitu komunikat brzmi limit must be a whole number from 1 to 50:
```
{ "error": { "code": "invalid_query", "message": "page must be a whole number from 1" } }
```
Stronicuj na końcu: najpierw filtruj i sortuj, a potem wybierz stronę. total zlicza zadania pozostałe po zastosowaniu filtrów, więc ?done=false&limit=1 zwraca "total": 2 i "pages": 2.

Zmienia to kształt odpowiedzi, więc klient, który oczekiwał tablicy, również musi zostać zmieniony. Lekcja o wersjonowaniu pokazuje, jak sobie z tym poradzić.

Wypróbuj: GET /api/tasks?limit=2 zwraca zadania 1 i 2, z wartościami "page": 1, "total": 3 i "pages": 2. GET /api/tasks?page=2&limit=2 zwraca tylko zadanie 3. Zwykłe GET /api/tasks zwraca wszystkie 3 zadania, z wartościami "page": 1 i "pages": 1. GET /api/tasks?page=0 zwraca status 400 i kod invalid_query.

Spróbuj swoich sił

import { Router } from 'express';
import { z } from 'zod';
import { sendError, sendInvalid } from '../errors.js';
import { nextId, tasks } from '../store.js';

const router = Router();

// Pełne zadanie w postaci przesyłanej przez PUT. .strict() odrzuca pola, których nie wymienia.
const Task = z
    .object({
        title: z.string().trim().min(1).max(100),
        done: z.boolean(),
    })
    .strict();
const NewTask = Task.partial({ done: true });
const TaskChanges = Task.partial();
const SORT_FIELDS = ['title', 'createdAt'];

// True, jeśli inne zadanie ma już taki tytuł, niezależnie od wielkości liter.
const titleTaken = (title, exceptId) =>
    tasks.some((t) => t.id !== exceptId && t.title.toLowerCase() === title.toLowerCase());

router.get('/', (req, res) => {
    const { done, q, sort } = req.query;
    let list = tasks;
    if (done !== undefined) {
        if (done !== 'true' && done !== 'false') {
            return sendError(res, 400, 'invalid_query', 'done must be true or false');
        }
        list = list.filter((t) => t.done === (done === 'true'));
    }
    if (q !== undefined) {
        const words = String(q).toLowerCase();
        list = list.filter((t) => t.title.toLowerCase().includes(words));
    }
    if (sort !== undefined) {
        const field = String(sort).startsWith('-') ? String(sort).slice(1) : String(sort);
        if (!SORT_FIELDS.includes(field)) {
            return sendError(
                res,
                400,
                'invalid_query',
                'sort must be title or createdAt, with - in front to reverse',
            );
        }
        const direction = String(sort).startsWith('-') ? -1 : 1;
        list = list.toSorted((a, b) => a[field].localeCompare(b[field]) * direction);
    }
    res.json(list);
});

router.get('/:id', (req, res) => {
    const task = tasks.find((t) => t.id === Number(req.params.id));
    if (!task) {
        return sendError(res, 404, 'not_found', 'Task not found');
    }
    res.json(task);
});

router.post('/', (req, res) => {
    const result = NewTask.safeParse(req.body);
    if (!result.success) {
        return sendInvalid(res, result.error);
    }
    const { title, done = false } = result.data;
    if (titleTaken(title)) {
        return sendError(res, 409, 'conflict', 'A task with this title already exists');
    }
    const task = { id: nextId(), title, done, createdAt: new Date().toISOString() };
    tasks.push(task);
    res.status(201).location(`/api/tasks/${task.id}`).json(task);
});

router.patch('/:id', (req, res) => {
    const task = tasks.find((t) => t.id === Number(req.params.id));
    if (!task) {
        return sendError(res, 404, 'not_found', 'Task not found');
    }
    const result = TaskChanges.safeParse(req.body);
    if (!result.success) {
        return sendInvalid(res, result.error);
    }
    if (result.data.title !== undefined && titleTaken(result.data.title, task.id)) {
        return sendError(res, 409, 'conflict', 'A task with this title already exists');
    }
    Object.assign(task, result.data);
    res.json(task);
});

router.put('/:id', (req, res) => {
    const index = tasks.findIndex((t) => t.id === Number(req.params.id));
    if (index === -1) {
        return sendError(res, 404, 'not_found', 'Task not found');
    }
    const result = Task.safeParse(req.body);
    if (!result.success) {
        return sendInvalid(res, result.error);
    }
    const { id, createdAt } = tasks[index];
    if (titleTaken(result.data.title, id)) {
        return sendError(res, 409, 'conflict', 'A task with this title already exists');
    }
    tasks[index] = { id, ...result.data, createdAt };
    res.json(tasks[index]);
});

router.delete('/:id', (req, res) => {
    const index = tasks.findIndex((t) => t.id === Number(req.params.id));
    if (index === -1) {
        return sendError(res, 404, 'not_found', 'Task not found');
    }
    tasks.splice(index, 1);
    res.status(204).end();
});

export default router;