PUTによる置き換え

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

編集フォームは、すべてのフィールドを一度に含むタスク全体を返送します。PUTは「このリソースに置き換える」という意味なので、リクエスト本文にはすべての情報が含まれていなければなりません。

PATCH /api/invoices/7  { "paid": true }               → paid changes
PUT   /api/invoices/7  { "amount": 90, "paid": true } → a new invoice 7
PUT   /api/invoices/7  { "paid": true }               → 400: amount missing

フィールドが欠けているPUTリクエストには400が返されます。不完全な請求書で置き換えると、金額が失われてしまうためです。idや作成日時のようにサーバーが管理するフィールドは、リクエスト本文ではなく、以前のバージョンから引き継がれます。

const { id, issuedAt } = invoices[index];
invoices[index] = { id, amount, paid, issuedAt };

チャレンジ

簡単

PUT /api/tasks/:id は本文の値で title と done を置き換え、タスクとともに 200 を返します。
id と createdAt はそのまま維持されます。
title または done が欠けている場合は 400。存在しない id の場合は 404。

PUT /api/tasks/2 に { "title": "Book the big room", "done": true } を送信し、次に { "done": true } を送信します。

自分で試してみよう

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

const router = Router();

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 ?? {};
    if (!title) {
        return res.status(400).json({ error: 'title is required' });
    }
    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) task.title = title;
    if (done !== undefined) task.done = done;
    res.json(task);
});

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;