Menu
CoddyTech

タスクの優先順位

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

この章はプロジェクトです。学んだことを活用して、API全体に機能を追加します。緊急のタスクもあるため、それぞれのタスクに優先度を設定します。1は高、2は普通、3は低です。

record Seat(int Row, [property: Range(1, 40)] int Number = 1);

[Range(1, 40)]は、1から40の範囲外の数値を拒否し、The field Number must be between 1 and 40.というメッセージを表示します。位置指定レコードのデフォルト値(= 1)は、フィールドを省略したJSON本文に適用されます。null許容プロパティでは、Rangeはnullを許容するため、PATCHに適しています。

challenge icon

チャレンジ

中級

すべてのタスクに優先度を設定します。1(高)から3(低)までです。これまでに作成したものはすべて維持し、すべてのエンドポイントがこれまでどおり動作するようにします。

  1. TaskItemの最後のプロパティとしてint Priority = 2を追加します。タスク1の優先度を1、タスク2の優先度を3にし、タスク3はデフォルトの2のままにします。
  2. TaskInputの最後のプロパティとして[property: Range(1, 3)] int Priority = 2を追加し、POSTとPUTで新しいTaskItemにinput.Priorityを渡します。
  3. TaskPatchに[property: Range(1, 3)] int? Priorityを追加します。PATCHの最初にValidation.Errors(patch)でパッチを検証し、エラーが見つかった場合はResults.ValidationProblemを返します。他のフィールドと同じように、withで優先度をコピーします。

これで、すべてのタスクに優先度が含まれます。{ "id": 1, "title": "Write the project brief", "done": false, "priority": 1 }。優先度に5を指定すると、400と"errors": { "priority": ["The field Priority must be between 1 and 3."] }が返されます。

試してみましょう:「実行」を押すと、リスト内のすべてのタスクに優先度が表示されます。POSTで{ "title": "Order new chairs" }を送信すると、優先度は2になります。POSTで{ "title": "Fix the printer", "priority": 5 }を送信すると、400が返されます。/api/tasks/3に{ "priority": 1 }を指定してPATCHすると、タスク3は緊急になり、タイトルはそのまま維持されます。

自分で試してみよう

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;

bool TitleTaken(string title, int exceptId) =>
    tasks.Any(t => t.Id != exceptId && string.Equals(t.Title, title, StringComparison.OrdinalIgnoreCase));

app.MapGet("/api/tasks", (bool? done, string? search, string? sort, HttpResponse response, int page = 1, int pageSize = 10) =>
{
    var errors = new Dictionary<string, string[]>();
    if (sort is not null && sort != "id" && sort != "title")
        errors["sort"] = ["Sort by id or title."];
    if (page < 1)
        errors["page"] = ["Page starts at 1."];
    if (pageSize < 1 || pageSize > 50)
        errors["pageSize"] = ["Page size is 1 to 50."];
    if (errors.Count > 0) return Results.ValidationProblem(errors);

    IEnumerable<TaskItem> result = tasks;
    if (done is not null) result = result.Where(t => t.Done == done);
    if (!string.IsNullOrWhiteSpace(search))
        result = result.Where(t => t.Title.Contains(search, StringComparison.OrdinalIgnoreCase));
    if (sort == "title") result = result.OrderBy(t => t.Title);

    var matching = result.ToList();
    response.Headers["X-Total-Count"] = matching.Count.ToString();
    return Results.Ok(matching.Skip((page - 1) * pageSize).Take(pageSize));
});

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);
    if (TitleTaken(input.Title, 0))
        return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
    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();
    if (TitleTaken(input.Title, id))
        return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
    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();
    if (patch.Title is not null && TitleTaken(patch.Title, id))
        return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
    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);

REST APIのすべてのレッスン