ページ分割
CoddyのASP.NET Coreジャーニー「REST API」セクションの一部。レッスン 13/20。
注文数が10,000件あるAPIでは、すべてを一度に返すことはできません。ページングでは、一部分ずつ返します。GET /api/orders?page=3&pageSize=20は、41件目から60件目までの注文を返します。クライアントには「全500ページ中の3ページ目」のように表示するための合計件数も必要です。ヘッダーを使えば、本文の形式を変えずにその件数を伝えられます。
app.MapGet("/api/orders", (HttpResponse response, int page = 1, int pageSize = 20) =>
{
var matching = orders.ToList();
response.Headers["X-Total-Count"] = matching.Count.ToString();
return Results.Ok(matching.Skip((page - 1) * pageSize).Take(pageSize));
});デフォルト値を設定すると、クエリパラメーターを省略可能にできます。HttpResponseパラメーターは構築中のレスポンスなので、返す前にヘッダーを設定できます。X-Total-Countは、ページングを行う前に、フィルターに一致する注文の件数を数えます。1未満のページ番号は拒否し、ページサイズには上限を設けて、どのクライアントも一度にすべてを要求できないようにしましょう。
チャレンジ
中級タスクに1ページずつ回答し、合計件数も伝えましょう。
GET /api/tasksのラムダに、sortの後ろに3つのパラメーターを追加します。HttpResponse response、int page = 1、int pageSize = 10です。- エラー辞書で、
pageが1未満の場合はpageの下にPage starts at 1.を追加し、pageSizeが1から50の範囲外の場合はpageSizeの下にPage size is 1 to 50.を追加します。 - フィルタリングと並べ替えの後、結果をリストに変換します。ヘッダー
X-Total-Countにその件数を設定し、ページ分だけを返します。(page - 1) * pageSize件のタスクをスキップし、その後pageSize件を取得します。
GET /api/tasks?page=2&pageSize=2 はタスク3のみを返し、X-Total-Count: 3 となります。最終ページを超えたページへの回答は200で、[] となります。
試してみましょう: 「実行」を押して GET /api/tasks?page=2&pageSize=2 を送信します。タスク3が返され、「Headers」タブに X-Total-Count: 3 と表示されます。GET /api/tasks?done=false&pageSize=1 を送信すると、タスク1と X-Total-Count: 2 が返されます。GET /api/tasks?page=0&pageSize=99 を送信すると、両方のエラーとともに400が返されます。
自分で試してみよう
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) =>
{
var errors = new Dictionary<string, string[]>();
if (sort is not null && sort != "id" && sort != "title")
errors["sort"] = ["Sort by id or title."];
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);
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);
このレッスンには短いクイズがあります。レッスンを始めて解答し、進捗を記録しましょう。