ページネーション

CoddyのNode.jsジャーニー「REST API」セクションの一部。レッスン 17/25。

1万件のタスクのリストは、1回の応答には長すぎます。ページに分けて送信しましょう。クライアントは?page=2&limit=20を要求して、その範囲のデータと、「全5ページ中の2ページ目」を表示するために必要な情報を受け取ります。

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

const start = (page - 1) * limit;    // page 1 は 0 から始まる
const items = list.slice(start, start + limit);
const pages = Math.ceil(list.length / limit);

totalはフィルター適用後に数えます。クライアントが要求したリストの件数を表すためです。クエリ文字列にpageがない場合は、数値に変換する前に1を使い、limitには10を使います。Number(undefined)はNaNだからです。その後、範囲内の整数でない値はすべて400で拒否します。limitに上限を設ければ、クライアントが一度にすべてを要求するのを防げます。

チャレンジ

簡単

1万件のタスクのリストは、1回のレスポンスに収めるには長すぎます。クライアントが「2ページ中1ページ目」と表示できるよう、リストをページに分けて送信しましょう。

routes/tasks.jsで、リストルートが返す内容を配列ではなくオブジェクトに変更します。最初のタスクを使ったGET /api/tasks?limit=2の戻り値は次のとおりです。
```
{
  "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にはこのページのタスクが入り、pageはページ番号、totalはフィルターに一致するタスクの数、pagesはページ数です。
クエリ文字列からpageとlimitを読み取ります。
- pageは1以上の整数です。指定されていない場合は1を使います。
- limitは1から50までの整数です。指定されていない場合は10を使います。
変換する前に既定値を使ってください。Number(undefined)はNaNになるためです。それ以外の値（page=0、page=abc、page=1.5、limit=0、limit=51）の場合はステータス400を返します。不正なlimitの場合のメッセージはlimit must be a whole number from 1 to 50です。
```
{ "error": { "code": "invalid_query", "message": "page must be a whole number from 1" } }
```
最後にページ分割します。まずフィルターと並べ替えを行い、その後で該当ページを取り出します。totalはフィルター適用後に残ったタスクの数です。そのため、?done=false&limit=1の場合、"total": 2、"pages": 2となります。

これによりレスポンスの形式が変わるため、配列を想定していたクライアント側も変更が必要です。その対応方法は、バージョニングのレッスンで説明します。

試してみましょう: GET /api/tasks?limit=2はタスク1と2を返し、"page": 1、"total": 3、"pages": 2となります。GET /api/tasks?page=2&limit=2はタスク3だけを返します。パラメーターなしのGET /api/tasksは3件すべてを返し、"page": 1、"pages": 1となります。GET /api/tasks?page=0は、コードinvalid_queryとともに400を返します。

自分で試してみよう

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

const router = Router();

// PUT で送信される完全なタスク。.strict() は定義されていないフィールドを受け付けません。
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。
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;