404ハンドラー

CoddyのNode.jsジャーニー「Expressの基礎」セクションの一部。レッスン 16/23。

Express は、未知のパスに対して独自のページ Cannot GET /x を返しますが、これはサイトにも API にもふさわしくありません。

app.use((req, res) => {
    res.status(404).send('No forecast here. Try /weather/oslo');
});

パスを指定しないミドルウェアは、そこに到達するすべてのリクエストに対して実行されます。これをすべてのルートと express.static の後に配置してください。それらが応答したリクエストはここには到達しないため、何も応答しなかったリクエストだけを受け取ります。このミドルウェア自身が応答するので、next は必要ありません。

req.path はクエリ文字列を含まないパスなので、req.path.startsWith('/api/') を使うと、API 呼び出しかページかを判別できます。

チャレンジ

簡単

存在しないパスにアクセスすると、Express の簡素な Cannot GET ページが表示されます。これを独自のものに置き換えましょう。API には JSON を、訪問者には親しみやすいページを返します。

server.js で、すべてのルートと express.static の後に、パスを指定せずに最後の app.use を追加します。すでに何かが応答したリクエストはここには到達しないため、何も処理しなかったリクエストだけを受け取ります。
パスが /api/ で始まる場合、ステータス 404 と次の JSON を返します: {"error": "Not found"}
それ以外のパスの場合、ステータス 404 と、Page not found という語句を含む HTML ページを返します。たとえば <h1>Page not found</h1> です。ホームページに戻るリンクを付けると、さらに親切です。

試してみましょう: 「実行」を押して、/api/nope を送信します。ステータス 404 と {"error":"Not found"} が表示されるはずです。/nope を送信すると、ステータス 404 で、Page not found と表示するページが描画されます。/api/recipes/1 を送信すると、ステータス 200 と Tomato Soup が返されます。これで、ルートが引き続き先に処理されることを確認できます。

自分で試してみよう

import { escapeHtml } from './html.js';
import express from 'express';
import { randomUUID } from 'node:crypto';
import { recipes } from './data.js';

const app = express();

app.use((req, res, next) => {
    console.log(`${req.method} ${req.url}`);
    next();
});

app.use((req, res, next) => {
    res.set('X-Request-Id', randomUUID());
    next();
});

app.use(express.json());

app.use(express.static('public'));

app.get('/', (req, res) => {
    const items = recipes.map((r) => `<li><a href="/recipes/${r.id}">${escapeHtml(r.title)}</a></li>`);
    res.send(`<link rel="stylesheet" href="/style.css"><h1>Recipe Box</h1><ul>${items.join('')}</ul>`);
});

// type('text') はプレーンテキストを送信するため、各タイトルがそれぞれ別の行に表示されます。
app.get('/recipes', (req, res) => {
    const { tag } = req.query;
    const list = tag ? recipes.filter((recipe) => recipe.tags.includes(tag)) : recipes;
    res.type('text').send(list.map((recipe) => recipe.title).join('\n'));
});

app.get('/recipes/:id', (req, res) => {
    const recipe = recipes.find((r) => r.id === Number(req.params.id));
    if (!recipe) {
        res.status(404).send('No such recipe');
        return;
    }
    res.send(recipe.title);
});

app.get('/api/recipes', (req, res) => {
    res.json(recipes);
});

app.get('/api/recipes/:id', (req, res) => {
    const recipe = recipes.find((r) => r.id === Number(req.params.id));
    if (!recipe) {
        res.status(404).json({ error: 'No such recipe' });
        return;
    }
    res.json(recipe);
});

app.post('/api/recipes', (req, res) => {
    const { title, tags } = req.body;
    if (!title) {
        res.status(400).json({ error: 'A recipe needs a title' });
        return;
    }
    const recipe = { id: recipes.length + 1, title, tags: tags ?? [] };
    recipes.push(recipe);
    res.status(201).json(recipe);
});

app.get('/about', (req, res) => {
    res.send('Recipe Box collects family recipes.');
});

app.get('/menu', (req, res) => {
    res.redirect(301, '/recipes');
});

app.get('/menu/:id', (req, res) => {
    res.redirect(301, `/recipes/${req.params.id}`);
});

app.listen(3000, () => {
    console.log('Recipe Box is running on port 3000');
});