競合
CoddyのASP.NET Coreジャーニー「REST API」セクションの一部。レッスン 9/20。
2人目のユーザーが「Ada」という名前を使うとログイン時に曖昧さが生じますが、リクエスト本文は有効です。これは409 Conflictです。つまり、リクエストがすでに保存されている内容と競合しています。400はリクエスト本文自体に誤りがあることを意味し、409は本文に問題はないものの、現時点では適用できないことを意味します。
bool NameTaken(string name, int exceptId) =>
users.Any(u => u.Id != exceptId &&
string.Equals(u.Name, name, StringComparison.OrdinalIgnoreCase));
if (NameTaken(input.Name, id))
return Results.Problem(title: "That name is taken.", statusCode: 409);「Ada」と「ada」は同じ名前として認識されるため、StringComparison.OrdinalIgnoreCaseを使って比較します。リクエストでユーザー名を変更するときは、そのユーザーを検索対象から除外します。そうしないと、名前を変更せずにフォームを保存した場合に、自分自身と競合してしまいます。Results.Problemは、指定したタイトルとステータスを含む問題詳細形式で応答します。
チャレンジ
中級「Send the invoice」というタスクが2つあると、リストが分かりにくくなります。別のタスクがすでに使っているタイトルは拒否しましょう。
Program.csで、nextIdの下にローカル関数bool TitleTaken(string title, int exceptId)を書きます。大文字と小文字を区別せず、exceptId以外のタスクがそのタイトルを持っている場合にtrueを返します。- POSTでは、検証の後に、タイトルがすでに使われている場合は
Results.Problem(title: "A task with this title already exists.", statusCode: 409)を返し、何も追加しません。POSTでは除外するタスクがないため、0を渡します。 - PUTでも同様に、タスクの
idを渡して確認します。これにより、タスクは自分のタイトルを維持したり、大文字・小文字を変えたりできます。 - PATCHでは、リクエスト本文にタイトルが含まれている場合(
patch.Titleがnullではない場合)にのみ確認します。
拒否されたリクエストでは何も変更されません。409の本文は次のとおりです。
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.10", "title": "A task with this title already exists.", "status": 409, "traceId": "..." }試してみましょう:「実行」を押し、{ "title": "book the MEETING room" }を/api/tasksにPOSTします。タスク2がそのタイトルを持っているため、409になります。{ "title": "Book the Meeting Room", "done": false }を/api/tasks/2にPUTすると、自分のタイトルなので200になります。{ "title": "Write the project brief" }を指定して/api/tasks/3にPATCHすると、409になります。{ "title": "Order new chairs" }をPOSTすると、id 4で201になります。
自分で試してみよう
using System.ComponentModel.DataAnnotations;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddProblemDetails();
var app = builder.Build();
app.UseExceptionHandler();
app.UseStatusCodePages();
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 errors = Validation.Errors(input);
if (errors is not null) return Results.ValidationProblem(errors);
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 errors = Validation.Errors(input);
if (errors is not null) return Results.ValidationProblem(errors);
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.MapPatch("/api/tasks/{id:int}", (int id, TaskPatch patch) =>
{
var index = tasks.FindIndex(t => t.Id == id);
if (index == -1) return Results.NotFound();
var task = tasks[index];
tasks[index] = task with
{
Title = patch.Title ?? task.Title,
Done = patch.Done ?? task.Done,
};
return Results.Ok(tasks[index]);
});
app.MapDelete("/api/tasks/{id:int}", (int id) =>
{
var removed = tasks.RemoveAll(t => t.Id == id);
return removed == 0 ? Results.NotFound() : Results.NoContent();
});
app.Run();
record TaskItem(int Id, string Title, bool Done);
record TaskInput(
[property: Required(ErrorMessage = "Title is required."), StringLength(80)] string Title,
bool Done);
record TaskPatch(string? Title, bool? Done);