Menu
CoddyTech

分页

本课属于 Coddy ASP.NET Core 学习旅程的“REST API”单元。第 13 课,共 20 课。

有 10,000 个订单的订单 API 无法一次性返回所有订单。分页会返回其中一段:GET /api/orders?page=3&pageSize=20对应第 41 到第 60 个订单。客户端还需要知道总数,才能显示“第 3 页,共 500 页”,而响应头可以携带总数,无需改变响应体的结构。

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 的页码,并限制每页大小,这样客户端就无法一次性请求所有内容。

challenge icon

挑战

中等

每次回答一页任务,并说明总共有多少个任务。

  1. 在 GET /api/tasks lambda 中的 sort 后面添加三个参数:HttpResponse response、int page = 1 和 int pageSize = 10。
  2. 在错误字典中,当 page 小于 1 时,在 page 下添加 Page starts at 1.;当 pageSize 超出 1 到 50 的范围时,在 pageSize 下添加 Page size is 1 to 50.。
  3. 筛选和排序后,将结果转换为列表。将标头 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);
quiz icon自我测试

这节课包含一个小测验。开始学习即可作答,并记录你的进度。

REST API中的所有课