zod ile Şemalar

Coddy'nin Node.js Journey'sinin REST API'leri bölümünün bir parçası. Ders 7 / 18.

Her alan ve her rota eklendikçe elle yapılan denetimler artar. Bir zod şeması yapıyı bir kez tanımlar ve safeParse bir değeri bu yapıya göre sınar:

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, name alanındaki boşluklar kırpılmış olarak doğrulanmış body içeriğini tutar

.strict(), şemada listelenmeyen alanları reddeder. Event.partial() her alanı isteğe bağlı yapar; PATCH için gereken budur. Event.partial({ seats: true }) ise yalnızca seats alanını isteğe bağlı yapar. z.flattenError sorunları alana göre listeler. Event.parse aynı denetimi yapar, ancak geçersiz bir değerle karşılaşırsa hata fırlatır; bir rotada fırlatılan hata 500 yanıtına dönüşür.

Görev

Kolay

Elle yapılan kontrolleri bir Task şemasıyla değiştir: title, 1 ila 100 karakterlik, başındaki ve sonundaki boşlukları kırpılmış bir dize; done, bir Boole değeri; .strict().
POST (done isteğe bağlı, varsayılan false), PATCH (tümü isteğe bağlı) ve PUT, safeParse kullanır; hatalı bir gövdeye, error olarak z.flattenError(result.error) içeren 400 yanıtı verilir.

Önce { "title": " Order new chairs ", "color": "red" } ile POST isteği gönder, ardından color olmadan gönder.

Kendin dene

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

const router = Router();

// Bir title değerinin neden saklanamadığı veya saklanabiliyorsa 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;