zodによるスキーマ

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

手作業でのチェックは、フィールドやルートが増えるたびに増えていきます。zodスキーマなら形状を一度記述でき、safeParseで値がそのスキーマに適合するか検証できます。

import { z } from 'zod';

const Event = z.object({
    name: z.string().trim().min(1).max(80),
    seats: z.number().int().min(1),
}).strict();

const result = Event.safeParse(req.body);
if (!result.success) {
    return res.status(400).json({ error: z.flattenError(result.error) });
}
// result.data には検証済みの body が格納されており、name は前後の空白が除去されている

.strict()は、スキーマに記載されていないフィールドを拒否します。Event.partial()を使うとすべてのフィールドが省略可能になり、PATCHで必要な動作になります。また、Event.partial({ seats: true })ではseatsだけが省略可能になります。z.flattenErrorはフィールドごとに問題を列挙します。Event.parseも同じ検証を行いますが、値が不正な場合は例外をスローし、ルート内で例外が発生すると500になります。

チャレンジ

簡単

手動チェックを Task スキーマに置き換えます。title は前後の空白を削除した1～100文字の文字列、done はブール値、そして .strict() を指定します。
POST（done は省略可能で、既定値は false）、PATCH（すべて省略可能）、PUT では safeParse を使います。不正なリクエストボディには、z.flattenError(result.error) を error として含む400を返します。

{ "title": " Order new chairs ", "color": "red" } を使って POST を送信し、次に color を含めずに送信します。

自分で試してみよう

import { Router } from 'express';
import { nextId, tasks } from '../store.js';

const router = Router();

// titleを保存できない理由。保存できる場合はnull。
const titleError = (title) => {
    if (typeof title !== 'string' || title.trim() === '' || title.length > 100) {
        return 'title must be a string of 1 to 100 characters';
    }
    return null;
};

router.get('/', (req, res) => {
    res.json(tasks);
});

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

router.post('/', (req, res) => {
    const { title } = req.body ?? {};
    const problem = titleError(title);
    if (problem) {
        return res.status(400).json({ error: problem });
    }
    const task = { id: nextId(), title, done: false, 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 res.status(404).json({ error: 'Task not found' });
    }
    const { title, done } = req.body ?? {};
    if (title !== undefined && titleError(title)) {
        return res.status(400).json({ error: titleError(title) });
    }
    if (done !== undefined && typeof done !== 'boolean') {
        return res.status(400).json({ error: 'done must be true or false' });
    }
    if (title !== undefined) task.title = title;
    if (done !== undefined) task.done = done;
    res.json(task);
});

router.put('/:id', (req, res) => {
    const index = tasks.findIndex((t) => t.id === Number(req.params.id));
    if (index === -1) {
        return res.status(404).json({ error: 'Task not found' });
    }
    const { title, done } = req.body ?? {};
    if (title === undefined || done === undefined) {
        return res.status(400).json({ error: 'PUT needs every field: title and done' });
    }
    const { id, createdAt } = tasks[index];
    tasks[index] = { id, title, done, 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 res.status(404).json({ error: 'Task not found' });
    }
    tasks.splice(index, 1);
    res.status(204).end();
});

export default router;