Menu
CoddyTech

Stronicowanie

Część sekcji API REST ścieżki ASP.NET Core w Coddy. Lekcja 13 z 20.

API zamówień zawierające 10 000 zamówień nie może zwrócić ich wszystkich naraz. Stronicowanie zwraca jeden fragment: GET /api/orders?page=3&pageSize=20 obejmuje zamówienia od 41 do 60. Klient potrzebuje również łącznej liczby zamówień, aby wyświetlić „strona 3 z 500”, a nagłówek pozwala ją przekazać bez zmiany struktury treści odpowiedzi.

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

Wartość domyślna sprawia, że parametr zapytania jest opcjonalny. Parametr HttpResponse to tworzona odpowiedź, więc możesz ustawić nagłówek przed jej zwróceniem. X-Total-Count zlicza zamówienia spełniające kryteria filtrów przed stronicowaniem. Odrzucaj numery stron mniejsze niż 1 i ograniczaj rozmiar strony, aby żaden klient nie mógł zażądać wszystkiego naraz.

challenge icon

Wyzwanie

Średni

Odpowiadaj na zadania po jednej stronie i podaj ich łączną liczbę.

  1. Dodaj trzy parametry do lambdy GET /api/tasks, po sort: HttpResponse response, int page = 1 i int pageSize = 10.
  2. W słowniku błędów dodaj Page starts at 1. pod page, gdy page jest mniejsze niż 1, oraz Page size is 1 to 50. pod pageSize, gdy pageSize jest poza zakresem od 1 do 50.
  3. Po filtrowaniu i sortowaniu zamień wynik na listę. Ustaw nagłówek X-Total-Count na liczbę jej elementów, a następnie zwróć tylko stronę: pomiń (page - 1) * pageSize zadań i pobierz pageSize.

GET /api/tasks?page=2&pageSize=2 zwraca tylko zadanie 3, z X-Total-Count: 3. Strona poza zakresem zwraca 200 i [].

Wypróbuj: naciśnij „Uruchom” i wyślij GET /api/tasks?page=2&pageSize=2: zadanie 3, a karta Headers pokazuje X-Total-Count: 3. Wyślij GET /api/tasks?done=false&pageSize=1: zadanie 1 i X-Total-Count: 2. Wyślij GET /api/tasks?page=0&pageSize=99: 400 z oboma błędami.

Spróbuj swoich sił

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 iconSprawdź się

Ta lekcja zawiera krótki quiz. Zacznij lekcję, żeby na niego odpowiedzieć i śledzić swoje postępy.

Wszystkie lekcje w sekcji API REST