Menu
CoddyTech

並べ替え

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

sortパラメーターを使うと、クライアントが順序を選択できます: GET /api/products?sort=price。サポートしている順序だけを受け付け、それ以外には400を返しましょう。そうすれば、sort=priseのような入力ミスは無視されず、報告されます。

var errors = new Dictionary<string, string[]>();
if (sort is not null && sort != "name" && sort != "price")
    errors["sort"] = ["Sort by name or price."];
if (errors.Count > 0) return Results.ValidationProblem(errors);

if (sort == "price") result = result.OrderBy(p => p.Price);

OrderByは新しいソート済みのシーケンスを返し、リスト自体は変更しません。products.Sort(...)を使うと、保存されているリスト自体の順序が変わるため、その後のすべての応答も新しい順序で返されます。エラーを1つの辞書にまとめると、複数の間違いがあるリクエストについて、一度にすべてを知らせることができます。

challenge icon

チャレンジ

簡単

クライアントがタスクをタイトル順に並べ替えられるようにします。

  1. GET /api/tasks のラムダに3つ目のパラメーター string? sort を追加します。
  2. ラムダの先頭で、エラーを辞書に集めます。sort が null、id、title のいずれでもない場合は、sort の項目に Sort by id or title. を追加し、辞書にエラーがある場合は Results.ValidationProblem(errors) を返します。
  3. フィルターの後で、sort が title の場合は、OrderBy を使って結果をタイトル順に並べます。sort がない場合、または sort=id の場合、タスクはID順のままです。

GET /api/tasks?sort=title はタスク2、3、1を返します:Book、Send、Write。

試してみましょう:「実行」を押して GET /api/tasks?sort=title を送信します:上記の順序になります。GET /api/tasks を送信します:ID順に戻ります。GET /api/tasks?sort=size を送信します:"errors": { "sort": ["Sort by id or title."] } を伴う400が返ります。GET /api/tasks?done=false&sort=title を送信します:タスク3と1が返ります。

自分で試してみよう

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) =>
{
    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));
    return Results.Ok(result);
});

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のすべてのレッスン