Menu
CoddyTech

Phân trang

Thuộc phần REST API trong hành trình ASP.NET Core của Coddy. Bài học 13 trên 20.

Một API đơn hàng có 10.000 đơn không thể trả lời tất cả cùng lúc. Phân trang trả về một phần dữ liệu: GET /api/orders?page=3&pageSize=20 là các đơn từ 41 đến 60. Client cũng cần tổng số đơn để hiển thị "trang 3 trên 500", và một header sẽ mang thông tin này mà không làm thay đổi cấu trúc phần thân.

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));
});

Giá trị mặc định khiến tham số truy vấn trở thành tùy chọn. Tham số HttpResponse là phản hồi đang được tạo, vì vậy bạn có thể đặt header trước khi trả về. X-Total-Count đếm số đơn khớp với các bộ lọc trước khi phân trang. Từ chối trang nhỏ hơn 1 và giới hạn kích thước trang để không client nào có thể yêu cầu tất cả cùng lúc.

challenge icon

Thử thách

Trung bình

Trả lời các nhiệm vụ theo từng trang và cho biết tổng cộng có bao nhiêu nhiệm vụ.

  1. Thêm ba tham số vào lambda GET /api/tasks, sau sort: HttpResponse response, int page = 1 và int pageSize = 10.
  2. Trong từ điển lỗi, thêm Page starts at 1. dưới khóa page khi page nhỏ hơn 1, và Page size is 1 to 50. dưới khóa pageSize khi pageSize nằm ngoài khoảng từ 1 đến 50.
  3. Sau khi lọc và sắp xếp, chuyển kết quả thành danh sách. Đặt header X-Total-Count thành số lượng phần tử, rồi chỉ trả lời trang đó: bỏ qua (page - 1) * pageSize nhiệm vụ và lấy pageSize nhiệm vụ.

GET /api/tasks?page=2&pageSize=2 chỉ trả về nhiệm vụ 3, với X-Total-Count: 3. Trang vượt quá trang cuối trả về 200 và [].

Thử ngay: nhấn Run và gửi GET /api/tasks?page=2&pageSize=2: nhiệm vụ 3, và tab Headers hiển thị X-Total-Count: 3. Gửi GET /api/tasks?done=false&pageSize=1: nhiệm vụ 1 và X-Total-Count: 2. Gửi GET /api/tasks?page=0&pageSize=99: 400 với cả hai lỗi.

Tự làm thử

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 iconTự kiểm tra

Bài học này có một bài trắc nghiệm ngắn. Bắt đầu bài học để trả lời và theo dõi tiến độ.

Tất cả bài học trong REST API