Menu
CoddyTech

Paginasi

Termasuk bagian REST API dalam perjalanan ASP.NET Core di Coddy. Pelajaran 13 dari 20.

API pesanan dengan 10.000 pesanan tidak dapat menjawab semuanya sekaligus. Pembagian halaman menampilkan satu bagian: GET /api/orders?page=3&pageSize=20 berisi pesanan 41 sampai 60. Client juga memerlukan jumlah total untuk menampilkan "halaman 3 dari 500", dan header menyertakan jumlah itu tanpa mengubah bentuk body.

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

Nilai default membuat parameter kueri bersifat opsional. Parameter HttpResponse adalah respons yang sedang dibuat, jadi kamu dapat menetapkan header sebelum mengembalikannya. X-Total-Count menghitung pesanan yang cocok dengan filter, sebelum pembagian halaman. Tolak halaman di bawah 1 dan batasi ukuran halaman, agar client tidak dapat meminta semuanya sekaligus.

challenge icon

Tantangan

Sedang

Jawab tugas satu halaman setiap kali, dan sebutkan jumlah totalnya.

  1. Tambahkan tiga parameter ke lambda GET /api/tasks, setelah sort: HttpResponse response, int page = 1, dan int pageSize = 10.
  2. Di dictionary errors, tambahkan Page starts at 1. di bawah page saat page kurang dari 1, dan Page size is 1 to 50. di bawah pageSize saat pageSize di luar rentang 1 sampai 50.
  3. Setelah memfilter dan mengurutkan, ubah hasilnya menjadi list. Atur header X-Total-Count ke jumlahnya, lalu jawab hanya halaman tersebut: lewati (page - 1) * pageSize tugas dan ambil pageSize.

GET /api/tasks?page=2&pageSize=2 hanya menampilkan tugas 3, dengan X-Total-Count: 3. Halaman yang melewati akhir menampilkan 200 dan [].

Coba: tekan Jalankan dan kirim GET /api/tasks?page=2&pageSize=2: tugas 3, dan tab Headers menampilkan X-Total-Count: 3. Kirim GET /api/tasks?done=false&pageSize=1: tugas 1 dan X-Total-Count: 2. Kirim GET /api/tasks?page=0&pageSize=99: 400 dengan kedua error.

Coba sendiri

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 iconUji dirimu

Pelajaran ini berisi kuis singkat. Mulai pelajarannya untuk menjawab kuis dan melacak progresmu.

Semua pelajaran di REST API