- Day 56:データ更新 ― PUT・PATCHで保存済みのデータを変更する
- 今日のゴール
- 更新処理の全体像を確認する
- PUTとPATCHの違いを理解する
- 省略・空文字・nullを区別する
- PUTとPATCHの「べき等性」を理解する
- 今回の前提と変更ファイル
- 更新用の型を追加する
- PATCH用の入力検証を作る
- Prismaの更新サービスを追加する
- 既存の詳細APIへPUTとPATCHを追加する
- ステータスコードを整理する
- まずはcurlでAPIを確認する
- 更新確認用フォームを作る
- 更新確認ページを作る
- PATCHでメールが維持されたか確認する
- 正常系と異常系をテストする
- 同時更新で起こる問題を理解する
- セキュリティで特に注意すること
- よくあるつまずきと確認方法
- 自力で取り組む練習問題
- 型チェックと本番ビルドを確認する
- Day 56のチェックリスト
- まとめ
Day 56:データ更新 ― PUT・PATCHで保存済みのデータを変更する
Day 56では、Next.jsのRoute HandlersとPrismaを使って、保存済みのユーザー情報を更新します。Day 54でデータを作成し、Day 55で取得できるようになりました。今回は、CRUDの「Update」に取り組みます。
学習の中心は、「更新対象を特定する」「変更内容を検証する」「必要な項目だけ更新する」「結果を返す」という流れです。PUTとPATCHの違いに加え、未指定の項目を消さないこと、存在しないユーザーやメール重複を適切に扱うことも学びます。
今日のゴール
今回は、同じユーザー詳細URLへ、PUTとPATCHを追加します。
| 作るもの | リクエストの例 | 今回の動作 |
|---|---|---|
| PUT API | PUT /api/users/1 | 名前とメールアドレスを両方指定して更新します |
| PATCH API | PATCH /api/users/1 | 指定された項目だけを更新します |
| 更新確認フォーム | /users/update-demo | ユーザーIDと新しい名前を入力し、PATCHを送ります |
Day 55で作ったGET /api/users/[id]は残します。
今回は、認証機能のないローカル学習専用の実装です。 これまでと同じく、APIは開発環境でのみ更新を許可します。本物の個人情報ではなく、ダミーデータを使ってください。
更新処理の全体像を確認する
今回の処理は、次の順番で進みます。
更新したいユーザーIDと変更内容を指定する
↓
PUTまたはPATCHでAPIへ送信する
↓
APIがIDとJSONを読み取る
↓
更新内容をサーバー側で検証する
↓
Prismaが対象ユーザーを更新する
↓
更新結果をJSONで返す
↓
画面で成功・失敗を案内する
登録処理との大きな違いは、「すでに存在する、どの行を変更するか」を決めることです。
今回は、URLのIDで対象を指定します。
/api/users/1
↑
更新対象のID
更新する値は、JSONの本文で送ります。
PUTとPATCHの違いを理解する
PUTは、対象の表現を置き換えるために使います
HTTPにおけるPUTは、送信した内容で対象の表現を作成・置換するためのメソッドです。今回のAPIでは、既存ユーザーの更新だけを許可し、編集可能な項目をnameとemailに限定します。(🔗 developer.mozilla.org)
今回のPUTでは、次の両方を必須にします。
{
"name": "葵(変更後)",
"email": "aoi-updated@example.com"
}JSONJSONにはコメントを書けないため、JSONの例にはコメントを付けていません。
今回のPUTのルールは、次のとおりです。
nameを必ず指定します。emailを必ず指定します。- 片方がなければ、入力不正として拒否します。
idやcreatedAtは変更しません。- 存在しないユーザーは、新しく作らず404にします。
「全項目を送る」とは、DBにあるすべての列を利用者へ送信させる意味ではありません。
今回は、編集対象のプロフィールを「名前とメールアドレスの組」と定義し、その全体をPUTで受け取る設計です。bioなどを別途追加済みでも、今回は更新対象に含めません。
PATCHは、部分的な変更に使います
PATCHは、対象へ部分的な変更を適用するためのメソッドです。今回は、JSONに含まれている項目だけを変更する、独自のシンプルな更新形式として実装します。(🔗 developer.mozilla.org)
名前だけを変える場合は、次のように送ります。
{
"name": "葵(名前だけ変更)"
}JSONこのとき、メールアドレスは変更しません。
メールアドレスだけを変えることもできます。
{
"email": "aoi-new@example.com"
}JSON今回のPATCHは、JSON PatchやJSON Merge Patchの標準形式を実装するものではありません。application/jsonで受け取る、このAPI専用の部分更新ルールです。
同じ入力でもPUTとPATCHでは結果が違います
| 送信内容 | PUT | PATCH |
|---|---|---|
| 名前とメールの両方 | 更新できます | 更新できます |
| 名前だけ | 422で拒否します | 名前だけ更新します |
| メールだけ | 422で拒否します | メールだけ更新します |
| 空のオブジェクト | 422で拒否します | 422で拒否します |
name: null | 422で拒否します | 422で拒否します |
idなどの余分な項目 | 422で拒否します | 422で拒否します |
この表は、今回実装するAPIの契約です。
省略・空文字・nullを区別する
PATCHでは、特にこの違いが重要です。
項目を省略した場合
{
"name": "葵"
}JSON今回は、メールアドレスが含まれていないため、メールアドレスはそのまま残します。
空文字を指定した場合
{
"name": ""
}JSONこれは「名前を空文字へ変更したい」という入力です。
今回は名前を必須とするため、拒否します。
nullを指定した場合
{
"name": null
}JSONこれも、文字列としての名前ではないため拒否します。
| 入力 | 今回のPATCHでの意味 |
|---|---|
| 項目がない | 変更しません |
| 空文字 | 不正な値として拒否します |
null | 不正な型として拒否します |
| 正常な文字列 | 検証して更新します |
「送られていない」と「空にしたい」は、同じではありません。
任意項目を削除できるAPIを将来作る場合は、nullを削除指示として許可するかなど、項目ごとにルールを決めます。
PUTとPATCHの「べき等性」を理解する
べき等性とは、同じリクエストを繰り返しても、意図する結果が1回実行した場合と同じになる性質です。PUTはべき等なメソッドです。一方、PATCHは処理内容によって、べき等になる場合とならない場合があります。(🔗 developer.mozilla.org)
今回のPATCHは、値を指定して代入します。
{
"name": "葵"
}JSONほかの更新が介在しなければ、何回送っても名前は「葵」です。
一方、「ポイントを10増やす」という変更命令なら、繰り返すたびに増える可能性があります。
そのため、PATCHだから必ずべき等ではない、あるいは必ず非べき等である、と機械的に判断しないことが大切です。今回の「値を設定するPATCH」は、同じ入力で同じ項目を同じ状態にします。(🔗 developer.mozilla.org)
今回の前提と変更ファイル
Day 55までの、次の構成を引き継ぎます。
- Next.js App RouterとTypeScriptを使っています。
- PrismaからSQLiteへ接続できます。
emailに一意制約があります。- Prisma Clientの生成先は
src/generated/prismaです。 POST /api/usersで登録できます。GET /api/usersと詳細GETで取得できます。
今回はテーブル構造を変えないため、基本的にMigrationは不要です。
作成・変更するファイル
src/
├── app/
│ ├── api/
│ │ └── users/
│ │ ├── [id]/
│ │ │ └── route.ts ← PUTとPATCHを追加します
│ │ └── route.ts ← 一覧GETとPOSTを残します
│ └── users/
│ └── update-demo/
│ └── page.tsx ← 新規作成します
├── components/
│ └── UserUpdateForm.tsx ← 新規作成します
├── lib/
│ ├── prisma.ts
│ └── validation/
│ ├── user.ts ← Day 54の検証を使います
│ └── user-update.ts ← 新規作成します
├── services/
│ └── user.service.ts ← 更新関数を追加します
└── types/
└── user.ts ← 更新用の型を追加します
Prisma関連のパッケージは、現在動作している組み合わせを維持します。
更新用の型を追加する
Day 54で作成したCreateUserInputは、名前とメールアドレスの両方が必須でした。
今回は、部分更新を表す型を追加します。
src/types/user.tsへ追加するコード
// PATCHで変更可能な項目です。
// どちらも省略可能ですが、最低1項目必要かは実行時に確認します。
export type PatchUserInput = {
name?: string;
email?: string;
};TypeScript既存のCreateUserInput、UserSummary、UsersResponseは削除しません。
?があるだけでは入力検証になりません
name?: stringは、TypeScript上で名前の省略を許可する記述です。
しかし、外部から送られてきたJSONが本当にこの形か、空のオブジェクトではないかは、別途確認します。
今回も、受信値はunknownとして検証します。
PATCH用の入力検証を作る
PUTでは、Day 54のvalidateCreateUser()を再利用します。名前とメールアドレスを両方必須とし、今回も同じルールで確認するためです。
PATCHでは、存在する項目だけを検証する関数を新しく作ります。
src/lib/validation/user-update.ts
// 検証後に扱う部分更新データの型です
import type { PatchUserInput } from "../../types/user";
// 成功と失敗を区別する結果型です
type PatchValidationResult =
| {
success: true;
data: PatchUserInput;
}
| {
success: false;
message: string;
};
// 外部から届いた部分更新データを検証します
export function validatePatchUser(
input: unknown,
): PatchValidationResult {
// オブジェクト以外や配列は受け付けません
if (
typeof input !== "object" ||
input === null ||
Array.isArray(input)
) {
return {
success: false,
message: "更新内容をオブジェクトで送信してください。",
};
}
// 許可していない項目を拒否します
const allowedKeys = new Set(["name", "email"]);
if (Object.keys(input).some((key) => !allowedKeys.has(key))) {
return {
success: false,
message: "更新できない項目が含まれています。",
};
}
// 少なくとも1項目は必要です
if (!("name" in input) && !("email" in input)) {
return {
success: false,
message: "名前かメールアドレスを指定してください。",
};
}
// 検証した値だけを入れる新しいオブジェクトです
const data: PatchUserInput = {};
// nameが送られた場合だけ検証します
if ("name" in input) {
if (typeof input.name !== "string") {
return {
success: false,
message: "名前を文字列で入力してください。",
};
}
const name = input.name.trim();
if (name.length < 1 || name.length > 50) {
return {
success: false,
message: "名前は1〜50文字で入力してください。",
};
}
data.name = name;
}
// emailが送られた場合だけ検証します
if ("email" in input) {
if (typeof input.email !== "string") {
return {
success: false,
message: "メールアドレスを文字列で入力してください。",
};
}
const email = input.email.trim();
if (email.length < 1 || email.length > 254) {
return {
success: false,
message: "メールアドレスは254文字以内で入力してください。",
};
}
// Day 54と同じ、学習用の簡易チェックです
const simpleEmailPattern = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
if (!simpleEmailPattern.test(email)) {
return {
success: false,
message: "メールアドレスの形式を確認してください。",
};
}
data.email = email;
}
return {
success: true,
data,
};
}TypeScript入力検証では、許可項目、型、長さ、形式、省略やnullの扱いを明示します。ブラウザー側の制限だけでなく、サーバー側でも確認することが重要です。(🔗 cheatsheetseries.owasp.org)
一部が正しければ更新してよいのでしょうか
今回は、次のような入力をすべて拒否します。
{
"name": "葵",
"email": "不正な形式"
}JSON名前が正しくても、メールアドレスが不正なら、DB更新を呼び出しません。
「名前だけ保存され、メールだけ失敗した」という中途半端な結果を、今回のAPIでは作らない方針です。
検証ルールの重複は後から整理できます
名前やメールの条件は、作成用と更新用で一部重複しています。
今回は処理の違いを読みやすくするため、PATCH側へ明示しました。ルール変更が増えたら、フィールド単位の検証関数や検証ライブラリへ共通化します。
共通化する場合も、PUTの必須条件とPATCHの省略可能条件を混同しないようにします。
Prismaの更新サービスを追加する
次に、検証済みの値を使って更新する関数を作ります。
src/services/user.service.tsのimportを変更する
既存の型importへ、PatchUserInputを追加します。
// 既存の型に、部分更新用の型を追加します
import type {
CreateUserInput,
PatchUserInput,
UserSummary,
} from "../types/user";JSON既存の取得・作成処理は残します。
同じファイルへ更新関数を追加する
// 検証済みの項目を使って、指定ユーザーを更新します
export async function updateUser(
id: number,
input: PatchUserInput,
): Promise<UserSummary> {
// 別の呼び出し元から使う場合にも、IDの範囲を守ります
if (
!Number.isSafeInteger(id) ||
id < 1 ||
id > 2_147_483_647
) {
throw new RangeError("ユーザーIDが正しくありません。");
}
// 未指定の項目を、明示的なundefinedとして渡さないようにします
const data: PatchUserInput = {};
if (input.name !== undefined) {
data.name = input.name;
}
if (input.email !== undefined) {
data.email = input.email;
}
if (Object.keys(data).length === 0) {
throw new Error("更新する項目がありません。");
}
return prisma.user.update({
// 必ず主キーで1人を指定します
where: {
id,
},
data,
// レスポンスには今回必要な項目だけを返します
select: {
id: true,
name: true,
},
});
}JSONこのサービスは、入力内容の検証が済んでいることを前提にします。別のAPIやServer Actionから使う場合も、その入口で検証と権限確認を行います。
PATCHで省略したメールが消えない理由
名前だけを送った場合、Prismaへ渡すdataも次の形になります。
// emailという項目自体を含めません
const data = {
name: "葵(変更後)",
};JSON未指定のメールアドレスへ、空文字やnullを代入していません。
また、Prismaではundefinedの扱いが設定によって変わるため、今回は更新しない項目をオブジェクトへ含めない書き方にしています。(🔗 docs.prisma.io)
なぜ先に存在確認をしないのか
今回は、直接update()を実行し、対象が存在しなければ、そのエラーをAPI側で404へ変換します。
「先に取得して存在を確認する」方法でも、その直後に別の処理で削除される可能性があります。事前確認だけに頼らず、実際の更新結果を扱います。
Prismaでは、更新などに必要な対象が見つからない場合、既知のエラーコードP2025で報告されます。(🔗 docs.prisma.io)
既存の詳細APIへPUTとPATCHを追加する
Day 55の次のファイルを変更します。
src/app/api/users/[id]/route.ts
このファイルにある、次のコードは残します。
- 既存の
GET関数。 runtime = "nodejs"。RouteContext型。- 共通レスポンス用の
reply()関数。
Next.jsでは、ひとつのroute.tsへGET、PUT、PATCHなどを定義できます。また、動的ルートのparamsはPromiseとして受け取り、awaitして使います。(🔗 nextjs.org)
importを整理する
既存のimport部分を、次のようにします。
// JSONレスポンスを作ります
import { NextResponse } from "next/server";
// Prismaの既知エラーを判定します
import { Prisma } from "../../../../generated/prisma/client";
// 取得と更新のサービスを読み込みます
import {
getUserById,
updateUser,
} from "../../../../services/user.service";
// PUTは作成時と同じ必須項目を検証します
import { validateCreateUser } from "../../../../lib/validation/user";
// PATCHは指定された項目だけを検証します
import { validatePatchUser } from "../../../../lib/validation/user-update";TypeScript既存の同じimportを残して二重定義しないようにします。
既存の型と共通関数を確認する
Day 55のコードでは、次の定義があります。存在する場合は、追加し直しません。
// SQLiteのドライバーをNode.jsで使います
export const runtime = "nodejs";
// 動的ルートから受け取るパラメータです
type RouteContext = {
params: Promise<{
id: string;
}>;
};
// JSONレスポンスの共通処理です
function reply(body: unknown, status: number) {
return NextResponse.json(body, {
status,
headers: {
"Cache-Control": "no-store",
},
});
}TypeScript更新処理とPUT・PATCHを追加する
既存のGET関数の下へ、次のコードを追加します。
// PUTとPATCHで共通する、HTTP処理の流れです
async function handleUpdate(
request: Request,
context: RouteContext,
mode: "put" | "patch",
) {
// 認証未実装のため、開発環境だけで更新を許可します
if (process.env.NODE_ENV !== "development") {
return reply(
{
message: "この更新APIはローカル学習用です。",
},
403,
);
}
// URLのIDを読み取ります
const { id: rawId } = await context.params;
if (!/^[1-9]\d{0,9}$/.test(rawId)) {
return reply(
{
message: "ユーザーIDの形式が正しくありません。",
},
400,
);
}
const id = Number(rawId);
if (!Number.isSafeInteger(id) || id > 2_147_483_647) {
return reply(
{
message: "ユーザーIDが許可範囲を超えています。",
},
400,
);
}
// 今回受け付ける本文の形式を確認します
const mediaType = request.headers
.get("content-type")
?.split(";")[0]
.trim()
.toLowerCase();
if (mediaType !== "application/json") {
return reply(
{
message: "JSON形式で送信してください。",
},
415,
);
}
let body: unknown;
try {
body = await request.json();
} catch {
return reply(
{
message: "JSONを読み取れませんでした。",
},
400,
);
}
// PUTとPATCHで、入力の必須条件を切り替えます
const result =
mode === "put"
? validateCreateUser(body)
: validatePatchUser(body);
if (!result.success) {
return reply(
{
message: result.message,
},
422,
);
}
try {
const user = await updateUser(id, result.data);
return reply(
{
message: "ユーザー情報を更新しました。",
user,
},
200,
);
} catch (error) {
if (
error instanceof Prisma.PrismaClientKnownRequestError
) {
// 更新対象が存在しません
if (error.code === "P2025") {
return reply(
{
message: "ユーザーが見つかりません。",
},
404,
);
}
// 今回のモデルでは、メールの一意制約違反を扱います
if (error.code === "P2002") {
return reply(
{
message: "このメールアドレスは使用できません。",
},
409,
);
}
}
// 入力内容や接続先の詳細を、そのまま公開しません
console.error("ユーザー更新処理に失敗しました。");
return reply(
{
message: "更新できませんでした。時間をおいてお試しください。",
},
500,
);
}
}
// PUTでは、名前とメールの両方を必須にします
export async function PUT(
request: Request,
context: RouteContext,
) {
return handleUpdate(request, context, "put");
}
// PATCHでは、指定した項目だけを更新します
export async function PATCH(
request: Request,
context: RouteContext,
) {
return handleUpdate(request, context, "patch");
}TypeScript共通化しても、意味の違いは残す
PUTとPATCHは、IDの確認、JSONの読み取り、エラー処理が共通しています。
そこでHTTP処理の流れをまとめ、入力検証だけを切り替えました。
// 共通の流れの中で、更新ルールを切り替えます
const result =
mode === "put"
? validateCreateUser(body)
: validatePatchUser(body);TypeScript内部で同じupdateUser()を使っていても、PUTは両項目の指定が必須、PATCHは部分指定が可能という違いがあります。
違いを消すためではなく、同じ処理を重複させないための共通化です。
ステータスコードを整理する
| ステータス | 今回の意味 |
|---|---|
200 | 更新できました |
400 | IDの形式やJSONの構文が不正です |
403 | 開発環境以外なので拒否しました |
404 | 対象ユーザーが存在しません |
409 | メールアドレスが重複しています |
415 | JSON以外の形式です |
422 | 名前・メールなどの内容が条件を満たしません |
500 | 予期しないサーバー側の失敗です |
今回の更新成功時は、更新結果のJSONを返すため200を使います。
PUTの成功では、本文なしの204などを使う設計もありますが、204を返すならJSON本文は返しません。今回はレスポンス形式を統一するため、200とJSONにそろえます。(🔗 developer.mozilla.org)
まずはcurlでAPIを確認する
画面を作る前に、API単体で確かめます。
# 開発サーバーを起動します
npm run devBash最初に一覧APIを開き、更新するダミーユーザーのIDを確認します。
# 更新する前に、登録済みユーザーを確認します
curl -i "http://localhost:3000/api/users"Bash以下は、IDが1のダミーユーザーが存在する場合の例です。環境に合わせてIDを変更します。
PATCHで名前だけ更新する
# メールアドレスを送らず、名前だけを変更します
curl -i "http://localhost:3000/api/users/1" \
-X PATCH \
-H 'Content-Type: application/json' \
--data '{"name":"葵(PATCHで変更)"}'Bash想定されるレスポンス例です。
{
"message": "ユーザー情報を更新しました。",
"user": {
"id": 1,
"name": "葵(PATCHで変更)"
}
}JSONその後、詳細GETで名前の変更を確認します。
# 更新後のユーザーを取得します
curl -i "http://localhost:3000/api/users/1"BashPUTで両項目を更新する
# 名前とメールアドレスを両方指定します
curl -i "http://localhost:3000/api/users/1" \
-X PUT \
-H 'Content-Type: application/json' \
--data '{"name":"葵(PUTで変更)","email":"day56-aoi@example.com"}'Bashメールアドレスは、ほかのユーザーと重複しないダミー値を使います。
PUTで名前だけ送る
# PUTではメールが足りないため、422を期待します
curl -i "http://localhost:3000/api/users/1" \
-X PUT \
-H 'Content-Type: application/json' \
--data '{"name":"名前だけ"}'BashPATCHとの違いを、実際のレスポンスで確認します。
PATCHで空のオブジェクトを送る
# 更新項目がないため、422を期待します
curl -i "http://localhost:3000/api/users/1" \
-X PATCH \
-H 'Content-Type: application/json' \
--data '{}'BashWindowsのシェルなどでは、引用符や改行の書き方を環境に合わせて調整してください。
更新確認用フォームを作る
APIの動作が確認できたら、ブラウザーからPATCHを送ります。
今回は、仕組みを絞るために「IDを指定して、名前だけを変更するフォーム」にします。既存ユーザーを読み込んで全項目を編集する画面は、次の発展課題とします。
src/components/UserUpdateForm.tsx
"use client";
// 入力値と送信状態を管理します
import { useRef, useState } from "react";
import type { FormEvent } from "react";
// APIレスポンスから文字列メッセージだけを取り出します
function readMessage(value: unknown): string | null {
if (
typeof value === "object" &&
value !== null &&
"message" in value &&
typeof value.message === "string"
) {
return value.message;
}
return null;
}
export default function UserUpdateForm() {
const [userId, setUserId] = useState("");
const [name, setName] = useState("");
const [isSubmitting, setIsSubmitting] = useState(false);
const [successMessage, setSuccessMessage] = useState("");
const [errorMessage, setErrorMessage] = useState("");
// 再描画前の短い間隔の連続送信も抑えます
const submittingRef = useRef(false);
async function handleSubmit(
event: FormEvent<HTMLFormElement>,
) {
event.preventDefault();
if (submittingRef.current) {
return;
}
setSuccessMessage("");
setErrorMessage("");
const normalizedId = userId.trim();
// ブラウザー側でも、明らかな入力間違いを確認します
if (
!/^[1-9]\d{0,9}$/.test(normalizedId) ||
Number(normalizedId) > 2_147_483_647
) {
setErrorMessage("正しいユーザーIDを入力してください。");
return;
}
if (name.trim().length === 0) {
setErrorMessage("新しい名前を入力してください。");
return;
}
submittingRef.current = true;
setIsSubmitting(true);
try {
const response = await fetch(
`/api/users/${encodeURIComponent(normalizedId)}`,
{
method: "PATCH",
headers: {
"Content-Type": "application/json",
},
// 名前だけを送るため、メールは変更しません
body: JSON.stringify({
name,
}),
},
);
const payload: unknown = await response
.json()
.catch(() => null);
const message = readMessage(payload);
if (!response.ok) {
setErrorMessage(
message ?? "更新を完了できませんでした。",
);
return;
}
setSuccessMessage(
message ??
"更新しました。一覧を再取得して確認してください。",
);
} catch {
// 通信が切れても、更新自体は完了している可能性があります
setErrorMessage(
"通信結果を確認できませんでした。最新情報を取得してから再操作してください。",
);
} finally {
submittingRef.current = false;
setIsSubmitting(false);
}
}
return (
<section aria-labelledby="update-heading">
<h2 id="update-heading">名前を変更する</h2>
<form onSubmit={handleSubmit}>
<fieldset disabled={isSubmitting}>
<legend>更新対象と変更内容</legend>
<p>
<label htmlFor="update-user-id">
ユーザーID
</label>
<br />
<input
id="update-user-id"
name="userId"
type="text"
inputMode="numeric"
required
maxLength={10}
value={userId}
onChange={(event) => setUserId(event.target.value)}
/>
</p>
<p>
<label htmlFor="update-user-name">
新しい名前
</label>
<br />
<input
id="update-user-name"
name="name"
type="text"
required
maxLength={50}
value={name}
onChange={(event) => setName(event.target.value)}
/>
</p>
<button type="submit">
{isSubmitting ? "更新しています…" : "名前を更新する"}
</button>
</fieldset>
</form>
{successMessage && (
<p role="status">{successMessage}</p>
)}
{errorMessage && (
<p role="alert">{errorMessage}</p>
)}
</section>
);
}TSXresponse.okとcatchは役割が違います
HTTPの404や409、500を受け取っただけでは、通常fetch()のcatchへ入りません。
APIが返したHTTP結果はresponse.okなどで確認し、通信自体の失敗はcatchで扱います。(🔗 developer.mozilla.org)
今回も、Day 54と同じ考え方です。
成功後に入力値を残している理由
このフォームは更新確認用なので、どのIDを何へ変更したかを見直せるよう、成功後も入力値を残しています。
ただし、表示中の入力値はDBの最新情報を常に表すものではありません。更新結果を確認したい場合は、GETで取得し直します。
更新確認ページを作る
src/app/users/update-demo/page.tsx
// Metadata、リンク、更新フォームを読み込みます
import type { Metadata } from "next";
import Link from "next/link";
import UserUpdateForm from "../../../components/UserUpdateForm";
// ページのMetadataです
export const metadata: Metadata = {
title: "ユーザー更新の確認",
description: "PATCH APIによるデータ更新を学ぶページです。",
};
// ページ本体はServer Componentのままにします
export default function UserUpdateDemoPage() {
return (
<section>
<h1>ユーザー更新の動作確認</h1>
<p>
登録済みのダミーユーザーを、IDを指定して更新します。
</p>
<p>
<Link href="/users/api-demo">
ユーザー一覧を取得してIDを確認する
</Link>
</p>
{/* イベント処理が必要な部分だけをClient化します */}
<UserUpdateForm />
<p>
更新後は一覧画面で、もう一度「一覧を取得・更新する」を押してください。
</p>
</section>
);
}TSX次のURLを開きます。
http://localhost:3000/users/update-demo
操作の確認手順
/users/api-demoでユーザー一覧を取得します。- 更新するダミーユーザーのIDを確認します。
/users/update-demoでIDと新しい名前を入力します。- 更新ボタンを押します。
- 一覧画面へ戻り、再取得ボタンを押します。
- 対象ユーザーの名前が変わっているか確認します。
DBが更新されたことと、すでに取得済みの画面が更新されることは別です。
今回は、一覧の再取得を明示的な操作にしています。自動反映する画面を作るときは、更新成功後に取得関数を呼ぶなど、画面側の連携も設計します。
PATCHでメールが維持されたか確認する
今回のGET APIは、メールアドレスを返しません。
そのため、メールが変わっていないかを確認するためだけに、一般のレスポンスへメールを追加する必要はありません。
ローカル実習では、DB確認用ツールや、一時的なサーバー側の確認処理などで、前後の値を確認します。確認のために個人情報をブラウザーやログへ広く出す設計にはしないようにします。
正常系と異常系をテストする
実装後は、成功だけでなく失敗も確認します。
| 確認内容 | 操作・入力 | 期待する結果 |
|---|---|---|
| PUT成功 | 名前と未使用メールを指定 | 200、両方更新 |
| PATCH成功 | 名前だけ指定 | 200、名前だけ更新 |
| PATCH成功 | メールだけ指定 | 200、メールだけ更新 |
| PUTの不足 | 名前だけ指定 | 422、更新しない |
| 空のPATCH | {} | 422 |
| 不正な名前 | 空白だけの名前 | 422 |
| 型不正 | name: null | 422 |
| 不正な追加項目 | idなどを送信 | 422 |
| 不正ID | /api/users/abc | 400 |
| 未存在 | 存在しない有効範囲のID | 404 |
| メール重複 | 別ユーザーのメールを指定 | 409 |
| JSON破損 | 括弧が閉じていない本文 | 400 |
| 対象外形式 | text/plain | 415 |
| 開発環境以外 | 本番起動で更新 | 今回の制限で403 |
失敗したときに更新されていないかも見る
特に、名前とメールの両方を送って、片方だけ不正なケースを確認します。
{
"name": "この名前は保存されない想定",
"email": "不正な形式"
}JSON422になった後、GETで名前を確認し、更新前のままであることを確かめます。
「エラーが表示された」だけでなく、意図しない保存が行われていないことも確認します。
同時更新で起こる問題を理解する
ここからは、今回のコードにまだ含めていない、実務上の重要事項です。
別の人の変更を上書きする場合があります
たとえば、次の順番を考えます。
- Aさんが、名前とメールを取得します。
- Bさんも、同じ時点の情報を取得します。
- Aさんがメールを変更します。
- Bさんが古いメールを含むPUTを送り、名前を変更します。
BさんのPUTに古いメールが入っていると、Aさんの変更を上書きする可能性があります。
PATCHでもすべての競合は防げません
名前だけのPATCHなら、メールを無用に上書きしにくくなります。
しかし、AさんもBさんも名前を変更した場合は、同じ項目への競合が残ります。
部分更新にすれば、同時更新問題がすべて解決するわけではありません。
発展として楽観的ロックを検討する
実際のアプリでは、更新前に取得したバージョンなどを条件に含め、「自分が見た状態から変更されていない場合だけ更新する」仕組みを検討します。
HTTPでは、ETagとIf-Matchなどによる条件付き更新で、更新の取りこぼしを防ぐ方法があります。今回のコードでは未実装です。(🔗 developer.mozilla.org)
セキュリティで特に注意すること
IDの検証と権限確認は別です
今回のコードは、「IDが正しい形式か」を確認しています。
しかし、それだけでは、そのユーザーを操作してよい人か分かりません。
公開するAPIでは、少なくとも次のような判断が必要です。
- ログインしていますか。
- 本人の情報を更新していますか。
- 管理者として更新できる範囲ですか。
- メールアドレス変更に追加の確認が必要ですか。
保護が必要なAPIでは、各エンドポイントで適切にアクセス制御します。画面のボタンを隠すだけでは保護になりません。(🔗 cheatsheetseries.owasp.org)
送信されたオブジェクトを丸ごと保存しない
今回は、許可した項目だけを検証し、新しいdataを作っています。
将来、モデルに管理者フラグなどが増えても、入力をそのままPrismaへ渡す構成にしないようにします。入力検証では、意図した項目だけをアプリのデータへ結び付けることが重要です。(🔗 cheatsheetseries.owasp.org)
メール変更は、文字列を書き換える以上の処理になる場合があります
今回のメールは、ダミーデータの連絡先項目です。
実際の認証アカウントに使うメールであれば、再認証や変更先アドレスの確認など、アプリの認証設計と合わせて検討します。
単なるプロフィール編集と、本人確認に使う情報の変更を同じ扱いにしないようにします。
開発環境限定でも、外部へ公開しない
NODE_ENVによる拒否は、学習用の事故防止です。ログイン認証の代わりではありません。
今回の実習中は、開発サーバーをインターネットへ公開せず、ダミーデータだけを扱います。
公開前に必要な追加対策
認証・認可に加え、リクエスト頻度、本文サイズ、Cookie認証を使う場合のCSRF対策などを、利用構成に合わせて設計します。
文字数制限と本文サイズ制限は別です
今回の50文字や254文字という検証は、JSONを読み取った後の確認です。
最後に確認すること
大きすぎる本文を読み取る前の制限も必要です。公開APIでは、サーバーやゲートウェイ側の上限も含めて設定し、内部エラーの詳細をそのまま返さないようにします。(🔗 cheatsheetseries.owasp.org)
よくあるつまずきと確認方法
| 症状 | 確認すること | 改善の方向 |
|---|---|---|
| 405になる | PUT・PATCHをexportしたか | 詳細側のroute.tsを確認します |
| 404になる | 対象ユーザーが存在するか | 一覧GETでIDを確認します |
| PUTで422になる | 両項目があるか | 名前とメールを指定します |
| PATCHで項目が消える | 空文字やnullを補っていないか | 省略した項目をdataへ入れません |
| 409になる | メールが重複していないか | 別のダミーメールで確認します |
| 名前が変わって見えない | 画面の再取得 | 一覧GETを再実行します |
GETが消えた | ファイルを置き換えていないか | GETを残してPUT・PATCHを追加します |
| 型やimportでエラーになる | 追加箇所と相対パス | 重複importや型名を確認します |
| 本番起動で403になる | 開発専用制限 | 今回は意図した動作です |
自力で取り組む練習問題
メールだけ更新するフォームを作る
名前更新フォームを参考に、メールだけを送るPATCHフォームを作ります。
- 送信項目を
emailだけにします。 - メール重複の409を表示します。
- 失敗時には入力値を残します。
- API側の検証もそのまま残します。
PUT用フォームを作る
名前とメールを入力し、両方を送信するフォームを作ります。
片方を送らない場合に、PATCHとは異なり拒否されることを確認します。
既存情報をフォームへ読み込む設計に発展させる場合は、メールを取得できる利用者の権限も考えます。
更新後に一覧を自動再取得する
同じページへ一覧と更新フォームを配置します。
更新成功時に一覧を取得し直すため、どのコンポーネントが取得関数や一覧のStateを持つかを考えます。
DB更新と画面更新を、別々の役割として整理する練習です。
プロフィール欄の部分更新を設計する
bioがある場合、次の仕様を先に決めます。
- 省略したら、現在の値を残しますか。
- 空文字を許可しますか。
nullで未設定へ戻せますか。- 何文字まで許可しますか。
- PUTの編集対象にも含めますか。
列があるからすぐ送信可能にするのではなく、APIの意味を決めてから実装します。
型チェックと本番ビルドを確認する
# 生成クライアントを確認・更新します
npx prisma generate
# TypeScriptの整合性を確認します
npx tsc --noEmit
# 本番用にビルドします
npm run build
# 本番用サーバーを起動します
npm run startBash今回の更新APIは、本番起動では403を返します。
公開するときは、この制限を削除するだけで済ませず、先に必要な認証・認可などを実装します。
Day 56のチェックリスト
- PUTとPATCHの違いを説明できます。
- 今回のPUTで必須となる項目を説明できます。
- PATCHで、指定された項目だけを更新できます。
- 省略・空文字・
nullを区別できます。 - URLのIDと本文をサーバー側で検証できます。
- 主キーで更新対象を限定できます。
- 既存のGETを残したままPUT・PATCHを追加できました。
- 対象未存在を404、メール重複を409として扱えます。
- フォームからPATCHを送信できます。
- 更新後の値をGETで確認できます。
- 同時更新への対策は、今回のコードにまだ含まれていないと理解しています。
- IDの指定と操作権限が別の問題だと理解しています。
まとめ
Day 56では、既存ユーザーを更新するPUT APIとPATCH APIを作りました。
今回の中心は、PUTでは編集対象の項目をそろえて受け取り、PATCHでは送られた項目だけを変更することです。特にPATCHでは、項目の省略を空文字やnullへ置き換えず、「変更しない」として扱いました。
更新処理では、対象の特定、入力検証、DB制約、操作権限、画面の再取得を分けて考えることが大切です。作成・取得・更新がそろったことで、ユーザー管理だけでなく、記事編集やタスク変更にも応用できるCRUDの基礎が整ってきました。
