セットアップ
本章のフロントエンドのハンズオンに入る前に、下準備として2つの作業を行います。1つはハンズオン用のNext.jsプロジェクトの作成、もう1つはフロントエンドから呼び出す先となる動作確認用の簡易APIの作成です。どちらもこの後のfetch API / TanStack Query のハンズオンで共通して使う土台になります。
1. サンプルプロジェクトの準備
コードを書き始める土台として、Next.jsのプロジェクトを1つ用意します。前章の Next.jsのスタイリング で作ったプロジェクトをそのまま使っても構いませんが、この章では説明のしやすさを優先して新規プロジェクトを作成する前提で進めます。
任意の場所に作業用のフォルダを作り、その中でNext.jsプロジェクトを作成します。ここでは frontend-fetch-demo という名前でプロジェクトを作ります。ターミナル(macOSはターミナル、WindowsはPowerShell)を開きます。
以下のコマンドで、npm がインストールされていることを確認します。npx は npm に同梱されているため、npm のバージョンが確認できれば npx も利用できます。
npm --version
以下のように npm のバージョンが表示されれば、インストールは確認できています。
11.x.x
バージョンが表示されない場合は、Node.jsをインストールしよう を先に実施してください。
インストールが確認できたら、プロジェクトを置きたいフォルダに cd で移動してから、以下のコマンドを実行します。
npx create-next-app@latest frontend-fetch-demo
対話式の質問が表示されます。以下のように回答します。
| 質問 | 回答 | 設定の基準 |
|---|---|---|
| Would you like to use the recommended Next.js defaults? | Yes, use recommended defaults |
TypeScript / ESLint / Tailwind CSS / App Router / Turbopack など、本章のハンズオンに必要な構成が一括で揃う |
インストールが終わったら、以下のコマンドで、作成したプロジェクトフォルダに移動します。
cd frontend-fetch-demo
続けて、このフォルダをVisual Studio Codeで開きます。「ファイル」→「フォルダーを開く」から frontend-fetch-demo フォルダを選択します。以降の操作はVisual Studio Codeのターミナルから行います。
まず、初期状態の画面を確認しておきます。ターミナルで以下を実行します。
npm run dev
ブラウザで http://localhost:3000 を開くと、以下のように Next.js のウェルカムページが表示されます。
画面中央に Next.js のロゴと初期テンプレートのリンクが表示されていれば、開発サーバは正常に起動しています。この開発サーバは以降のハンズオンでもずっと起動したままにします。
2. 簡易APIの作成
以降のフロントエンドのハンズオンで呼び出す先として、Next.js の Route Handlers で動作確認用の簡易 API を用意します。本章のテーマはフロントエンド側のデータ取得であり、バックエンドの設計自体には踏み込まないため、同じNext.jsプロジェクト内に最小限の API を作るだけにとどめます。実装するのは、タスクの一覧を返す GET /api/tasks と、タスクを追加する POST /api/tasks の2つです。データはメモリ上の配列で持つだけの簡易実装にとどめ、DBは使いません(サーバを再起動すると初期化されます)。
route.ts の作成
Route Handlersを配置するために、app/api/tasks/ フォルダの中に route.ts を作ります。Visual Studio Codeのエクスプローラーで app フォルダを右クリックし、「新しいフォルダー」から api/tasks を作成し、その中に route.ts を新規作成します。
frontend-fetch-demo
├── app/
│ ├── api/ ← このフォルダを作成
│ │ └── tasks/ ← このフォルダを作成
│ │ └── route.ts ← このファイルを作成
│ ├── layout.tsx
│ ├── page.tsx
│ └── ...
└── ...
Route Handlersは、HTTPメソッドと同名の関数をexportすると、そのメソッドのハンドラーになります。書き方は以下のとおりです。
// app/api/エンドポイント名/route.ts
import { NextResponse } from "next/server";
export async function GET(request: Request) {
// 一覧取得などの処理
return NextResponse.json(データ);
}
export async function POST(request: Request) {
const body = await request.json();
// 追加などの処理
return NextResponse.json(データ, { status: ステータスコード });
}
以下は、タスク一覧を返しつつタスクを追加できるようにした route.ts の実装例です。作成した route.ts に以下の内容を記述して保存します。
import { NextResponse } from "next/server";
type Task = {
id: number;
title: string;
done: boolean;
};
let tasks: Task[] = [
{ id: 1, title: "Next.jsのRoute Handlersを試す", done: false },
{ id: 2, title: "fetch APIでデータを取得する", done: false },
];
let nextId = 3;
export async function GET() {
return NextResponse.json(tasks);
}
export async function POST(request: Request) {
const body = await request.json();
const title = typeof body?.title === "string" ? body.title.trim() : "";
if (!title) {
return NextResponse.json(
{ message: "title is required" },
{ status: 400 },
);
}
const task: Task = { id: nextId++, title, done: false };
tasks = [...tasks, task];
return NextResponse.json(task, { status: 201 });
}
コードを解説します。
import { NextResponse } from "next/server";
NextResponse は、Route Handlersからのレスポンスを作るためのヘルパーです。NextResponse.json(データ) で、Content-Type: application/json を自動で付けたJSONレスポンスを返せます。
type Task = {
id: number;
title: string;
done: boolean;
};
let tasks: Task[] = [ ... ];
let nextId = 3;
タスクをメモリ上の配列 tasks で保持します。ここに書いた Task 型を、あとでフロントエンド側でも使い回します。実運用ではDBに保存する部分ですが、本章は「フロントとAPIの通信」に集中するため、意図的にメモリ持ちにしています。開発サーバを再起動すると tasks の中身は初期状態に戻ります。
export async function GET() {
return NextResponse.json(tasks);
}
GET という名前でエクスポートした関数が、GET /api/tasks のハンドラーになります。ここでは tasks 配列をそのままJSONで返しています。
export async function POST(request: Request) {
const body = await request.json();
const title = typeof body?.title === "string" ? body.title.trim() : "";
if (!title) {
return NextResponse.json(
{ message: "title is required" },
{ status: 400 },
);
}
const task: Task = { id: nextId++, title, done: false };
tasks = [...tasks, task];
return NextResponse.json(task, { status: 201 });
}
POST のハンドラーでは、リクエストボディを request.json() で読み取ってから、title が空文字でないかを確認します。空なら 400 Bad Request を返し、そうでなければ新しいタスクを配列に追加してから 201 Created を返します。バリデーションを1行入れておくと、あとでフロントエンド側からの誤ったリクエストを再現しやすく、動作確認しやすくなります。
保存できたら、npm run dev を実行中のターミナルにコンパイルエラーが出ていないことを確認します。エラーが出ていなければ、Route Handler側のファイルは準備完了です。次にAPIが単体で動くかを curl から検証します。
curl での API 動作確認
route.tsの実装が終わったら、フロントエンドと連携する前に APIが単体で正しく動作するか を確認しておきます。ここで動作確認しておくと、後でフロントエンドから呼び出して正しく動作しなかったときに、原因の切り分けがしやすくなります。
Visual Studio Codeで新しいターミナルを開きます(既存のターミナルは npm run dev を実行中のため、そのままにします)。まずは一覧取得を確認します。
curl http://localhost:3000/api/tasks
以下のような実行結果が表示されます。
[{"id":1,"title":"Next.jsのRoute Handlersを試す","done":false},{"id":2,"title":"fetch APIでデータを取得する","done":false}]
続いてPOSTでタスクを1件追加します。
curl -X POST http://localhost:3000/api/tasks -H "Content-Type: application/json" -d '{"title":"curlで追加したタスク"}'
以下のような実行結果が表示されます。
{"id":3,"title":"curlで追加したタスク","done":false}
もう一度GETすると、追加したタスクが増えていることを確認できます。
curl http://localhost:3000/api/tasks
以下のような実行結果が表示されます。
[{"id":1,"title":"Next.jsのRoute Handlersを試す","done":false},{"id":2,"title":"fetch APIでデータを取得する","done":false},{"id":3,"title":"curlで追加したタスク","done":false}]
3件目に curlで追加したタスク が表示されれば、Route HandlersのGET/POSTがどちらも正しく動作しています。
⚠️ Address already in use エラーが出る場合 |
|---|
npm run dev を別のターミナルですでに起動していないか確認してください。すでに起動していれば新たに起動する必要はなく、そのままブラウザで http://localhost:3000 を開けます。別プロセスが3000番ポートを掴んでいる場合は、そのプロセスを終了するか、npm run dev -- -p 3001 のように別ポートで起動します。 |