Menu
CoddyTech

Paginação

Parte da seção APIs REST do Journey de ASP.NET Core da Coddy. Lição 13 de 20.

Uma API de pedidos com 10.000 pedidos não consegue responder a todos de uma só vez. Paginação responde a uma parte: GET /api/orders?page=3&pageSize=20 corresponde aos pedidos de 41 a 60. O cliente também precisa do total para exibir "página 3 de 500", e um cabeçalho o transporta sem alterar a estrutura do corpo.

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

Um valor padrão torna um parâmetro de consulta opcional. Um parâmetro HttpResponse é a resposta que está sendo criada, então você pode definir um cabeçalho antes de retornar. X-Total-Count conta os pedidos que correspondem aos filtros antes da paginação. Recuse páginas menores que 1 e limite o tamanho da página para que nenhum cliente possa solicitar tudo de uma só vez.

challenge icon

Desafio

Médio

Responda às tarefas uma página por vez e informe quantas há no total.

  1. Adicione três parâmetros à lambda GET /api/tasks, depois de sort: HttpResponse response, int page = 1 e int pageSize = 10.
  2. No dicionário de erros, adicione Page starts at 1. em page quando page for menor que 1, e Page size is 1 to 50. em pageSize quando pageSize estiver fora do intervalo de 1 a 50.
  3. Depois de filtrar e ordenar, transforme o resultado em uma lista. Defina o cabeçalho X-Total-Count como a quantidade de itens da lista e, em seguida, responda apenas com a página: ignore (page - 1) * pageSize tarefas e pegue pageSize.

GET /api/tasks?page=2&pageSize=2 responde apenas com a tarefa 3, com X-Total-Count: 3. Uma página além do fim responde com 200 e [].

Experimente: pressione Executar e envie GET /api/tasks?page=2&pageSize=2: tarefa 3, e a aba Headers mostra X-Total-Count: 3. Envie GET /api/tasks?done=false&pageSize=1: tarefa 1 e X-Total-Count: 2. Envie GET /api/tasks?page=0&pageSize=99: 400 com os dois erros.

Experimente você mesmo

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 iconTeste seus conhecimentos

Esta lição inclui um quiz rápido. Comece a lição para respondê-lo e acompanhar seu progresso.

Todas as lições de APIs REST