Menu
CoddyTech

Skema dengan zod

Termasuk bagian REST API dalam perjalanan Node.js di Coddy. Pelajaran 11 dari 25.

Pemeriksaan manual bertambah seiring bertambahnya setiap bidang dan rute. Skema zod menjelaskan bentuknya sekali, lalu safeParse menguji nilai berdasarkan skema tersebut:

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 berisi body yang sudah diperiksa, dengan name yang sudah dipangkas spasinya

.strict() menolak bidang yang tidak dicantumkan dalam skema. Event.partial() membuat setiap bidang bersifat opsional, sesuai kebutuhan PATCH. Event.partial({ seats: true }) hanya membuat seats opsional, sedangkan const { seats = 1 } = result.data menggunakan 1 jika nilainya tidak ada. z.flattenError(result.error) mengubah masalah menjadi { formErrors, fieldErrors }: formErrors memuat masalah pada seluruh isi permintaan, seperti bidang yang tidak dikenal, sedangkan fieldErrors memuat masalah pada setiap bidang. Event.parse melakukan pemeriksaan yang sama, tetapi melempar error jika nilainya tidak valid. Error yang dilempar dalam rute akan menjadi 500.

challenge icon

Tantangan

Mudah

Langkah ini membuka proyek API pelacak tugas yang sudah disiapkan untuk kursus, bukan file proyekmu dari Memvalidasi Input (termasuk routes/tasks.js). Pekerjaanmu sebelumnya tetap berada di pelajarannya sendiri. Baca file yang disediakan sebelum mengedit routes/tasks.js. Salinan ini berisi rute CRUD tugas dan validasi input yang ditulis secara manual.

Pemeriksaan yang ditulis secara manual akan bertambah untuk setiap field dan setiap rute. Jelaskan sebuah tugas satu kali dengan skema zod, lalu gunakan skema itu di ketiga rute yang menerima body.

  1. Di routes/tasks.js, impor z dari zod dan tulis skema bernama Task:
    • title: sebuah string yang dipangkas, 1 sampai 100 karakter setelah dipangkas.
    • done: true atau false (z.boolean()).
    • Skemanya strict, jadi field yang tidak tercantum di dalamnya, seperti color, akan ditolak.

    Hapus helper titleError yang disediakan (versi kursus untuk validasi dari Memvalidasi Input).

  2. Buat dua versi dari Task dengan .partial(). Versi POST hanya menjadikan done opsional. Versi PATCH menjadikan kedua field opsional. PUT menggunakan Task itu sendiri, jadi kedua field diperlukan.
  3. Di POST, PATCH, dan PUT, periksa req.body dengan safeParse. Jika pemeriksaan gagal, kirim respons dengan status 400 dan daftar masalah dari zod di bawah error, yang dibuat dengan z.flattenError(result.error). Untuk { "title": 123 }, hasilnya seperti ini:
    { "error": { "formErrors": [], "fieldErrors": { "title": ["Invalid input: expected string, received number"] } } }
  4. Jika pemeriksaan berhasil, simpan dari result.data, bukan req.body: nilai ini menyimpan title yang sudah dipangkas. Di POST, body tanpa done akan membuat tugas dengan "done": false (field yang tidak ada bernilai undefined di result.data, dan ?? memberikan nilai cadangan). PUT tetap mempertahankan id dan createdAt dari tugas yang tersimpan.

Coba: kirim POST { "title": " Order new chairs ", "color": "red" } ke /api/tasks. Kamu mendapat 400, dan formErrors menyatakan Unrecognized key: "color". Kirim lagi tanpa color: kamu mendapat 201 dengan "title": "Order new chairs" (tanpa spasi) dan "done": false. PATCH /api/tasks/2 dengan { "done": "yes" } mengembalikan 400 dengan entri done di fieldErrors. PUT /api/tasks/2 dengan { "title": "Book the big room", "done": false } mengembalikan 200, dengan createdAt lama dari tugas 2.

Coba sendiri

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

const router = Router();

// Alasan title tidak bisa disimpan, atau null jika bisa.
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;

Semua pelajaran di REST API

Latihan sendiri: Playground Express