Menu
CoddyTech

DELETEによる削除

CoddyのASP.NET Coreジャーニー「REST API」セクションの一部。レッスン 5/20。

DELETEは項目を削除します。成功すると、応答は204 No Contentです。本文が空の成功応答です。表示するものが残っていないためです。項目が存在しない場合、応答は404です。

app.MapDelete("/api/notes/{id:int}", (int id) =>
{
    var removed = notes.RemoveAll(n => n.Id == id);
    return removed == 0 ? Results.NotFound() : Results.NoContent();
});

RemoveAllは削除した項目の数を返します。削除済みのIDが新しい項目に割り当てられることはありません。URL /api/notes/7を保持していたクライアントは、後で他の人のメモではなく404を受け取る必要があります。カウンターを使えばそれを実現できます。最大のIDに1を足す方法では実現できません。最新のメモが削除された後、次のメモにそのIDが割り当てられてしまいます。

challenge icon

チャレンジ

簡単

クライアントがタスクを削除できるようにしましょう。

  1. Program.csでDELETE /api/tasks/{id:int}をマッピングします。
  2. tasks.RemoveAllでタスクを削除します。何も削除されなかった場合はResults.NotFound()を返し、それ以外の場合はResults.NoContent()を返します。ステータスコードは204で、本文は空です。
  3. nextIdからIDを割り当て続けます。DELETE /api/tasks/3の後に追加される新しいタスクのIDは3ではなく4です。

試してみましょう:「実行」を押し、DELETEを選び、パスに/api/tasks/3を指定して「送信」します。204が返り、本文は空です。GET /api/tasksを「送信」すると、タスクが2つ残っています。もう一度DELETE /api/tasks/3を「送信」すると404になります。最初の削除が先に実行されているためです。{ "title": "Order new chairs" }を/api/tasksにPOSTすると、IDは4になります。

自分で試してみよう

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.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.Run();

record TaskItem(int Id, string Title, bool Done);
record TaskInput(string Title, bool Done);
record TaskPatch(string? Title, bool? Done);

REST APIのすべてのレッスン