ステータスコード

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

プログラムは本文の前にステータスコードを読み取るため、200とともに送られたエラーは成功のように見えます。

app.get('/api/loans', (req, res) => {
    if (!req.query.member) {
        res.status(400).json({ error: 'Say which member' });
        return;
    }
    res.json(loansOf(req.query.member));
});

res.status(code)はステータスを設定してresを返すため、同じ行に.json(...)を続けて書けます。returnはエラーの後に関数を終了します。よく使うコードは次のとおりです。

200: 成功しました（デフォルト）。
201: 何かが作成されました。
400: リクエストに誤りがあります（フィールドがない場合など）。
404: そのパスまたはIDには何もありません。
500: サーバーでエラーが発生しました。

チャレンジ

簡単

APIを読み取るプログラムは、まずステータスコードを確認し、その後に本文を確認します。見つからない場合の処理が、どちらにも明確に伝わるようにしましょう。

server.jsの/api/recipes/:idルートで、idに一致するレシピがない場合の処理を変更します。ステータス404はそのままにして、テキストの代わりに次のJSONを送信します：{"error": "No such recipe"}
abcのように数値ではないidも、どのレシピにも一致しません。その場合も同じ404と同じJSONが返されます。

試してみましょう：「実行」を押して、/api/recipes/99を送信します。ステータス404と{"error":"No such recipe"}が表示されるはずです。/api/recipes/abcを送信すると、同じ404とJSONが返されます。/api/recipes/3を送信すると、ステータス200とLentil Curryのレシピが返されます。

自分で試してみよう

import express from 'express';
import { recipes } from './data.js';

const app = express();

app.get('/', (req, res) => {
    res.send('Welcome to Recipe Box');
});

// 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).send('No such recipe');
        return;
    }
    res.json(recipe);
});

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

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