PATCHによる部分更新
CoddyのASP.NET Coreジャーニー「REST API」セクションの一部。レッスン 4/20。
PATCHは、リクエスト本文で送られたフィールドだけを変更します。省略されたフィールドと設定されたフィールドを区別するには、パッチレコードのすべてのプロパティを nullable にします。フィールドがない場合はnullにバインドされます。
record ProfilePatch(string? Name, string? City);
profiles[index] = profile with
{
Name = patch.Name ?? profile.Name,
City = patch.City ?? profile.City,
};withはレコードをコピーし、指定したプロパティを変更します。??は、パッチがnullを含む場合に古い値を保持します。bool?も同じように機能します。falseはクライアントが送信した値で、nullは何も送信されなかったことを意味します。そのため、{ "city": "Lyon" }を送ると、プロフィールの名前はそのままで、都市が変わります。
チャレンジ
簡単クライアントが、タイトルを再送信せずに、タスクの1つのフィールド(完了のチェックなど)を変更できるようにします。
Program.csの末尾で、record TaskPatch(string? Title, bool? Done);を宣言します。PATCH /api/tasks/{id:int}を、int idとTaskPatch patchでマッピングします。そのIDのタスクがない場合は、Results.NotFound()を返します。- そうでない場合は、
withを使ってタスクのコピーを作成し、各プロパティにはパッチの値を設定します。ただし、パッチの値がnullの場合は、タスク自身の値を保持します。変更後のタスクをResults.Okで返します。
{ "done": true }を指定してPATCH /api/tasks/1を送信すると、200と次の内容が返ります。
{ "id": 1, "title": "Write the project brief", "done": true }試してみましょう:「実行」を押し、PATCHを選択し、パスに/api/tasks/1、本文に{ "done": true }を指定して「送信」します。タイトルはそのままで、上記の内容が返ります。{ "title": "Book the big room" }を指定してPATCH /api/tasks/2を送信すると、新しいタイトルになり、"done": trueはそのままです。PATCH /api/tasks/99を送信すると、404が返ります。
自分で試してみよう
var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();
var tasks = new List<TaskItem>
{
new(1, "Write the project brief", false),
new(2, "Book the meeting room", true),
new(3, "Send the invoice", false),
};
var nextId = 4;
app.MapGet("/api/tasks", () => tasks);
app.MapGet("/api/tasks/{id:int}", (int id) =>
{
var task = tasks.Find(t => t.Id == id);
return task is null ? Results.NotFound() : Results.Ok(task);
});
app.MapPost("/api/tasks", (TaskInput input) =>
{
var task = new TaskItem(nextId++, input.Title, input.Done);
tasks.Add(task);
return Results.Created($"/api/tasks/{task.Id}", task);
});
app.MapPut("/api/tasks/{id:int}", (int id, TaskInput input) =>
{
var index = tasks.FindIndex(t => t.Id == id);
if (index == -1) return Results.NotFound();
tasks[index] = new TaskItem(id, input.Title, input.Done);
return Results.Ok(tasks[index]);
});
app.Run();
record TaskItem(int Id, string Title, bool Done);
record TaskInput(string Title, bool Done);
このレッスンには短いクイズがあります。レッスンを始めて解答し、進捗を記録しましょう。