Menu
CoddyTech

Paginazione

Fa parte della sezione API REST del percorso ASP.NET Core di Coddy. Lezione 13 di 20.

Un'API degli ordini con 10.000 ordini non può rispondere a tutte le richieste in una volta sola. La paginazione restituisce una porzione: GET /api/orders?page=3&pageSize=20 corrisponde agli ordini dal 41 al 60. Il client ha bisogno anche del totale, per mostrare «pagina 3 di 500», e un'intestazione lo trasporta senza modificare la struttura del 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));
});

Un valore predefinito rende facoltativo un parametro di query. Un parametro HttpResponse è la risposta in fase di costruzione, quindi puoi impostare un'intestazione prima di restituirla. X-Total-Count conta gli ordini che corrispondono ai filtri, prima della paginazione. Rifiuta le pagine inferiori a 1 e limita la dimensione della pagina, così nessun client può richiedere tutto in una volta.

challenge icon

Sfida

Medio

Rispondi alle attività una pagina alla volta e indica quante sono in totale.

  1. Aggiungi tre parametri alla lambda GET /api/tasks, dopo sort: HttpResponse response, int page = 1 e int pageSize = 10.
  2. Nel dizionario degli errori, aggiungi Page starts at 1. sotto page quando page è inferiore a 1, e Page size is 1 to 50. sotto pageSize quando pageSize è al di fuori dell'intervallo da 1 a 50.
  3. Dopo aver filtrato e ordinato, trasforma il risultato in una lista. Imposta l'intestazione X-Total-Count sul suo conteggio, poi rispondi solo con la pagina: salta (page - 1) * pageSize attività e prendine pageSize.

GET /api/tasks?page=2&pageSize=2 risponde solo con l'attività 3, con X-Total-Count: 3. Una pagina oltre l'ultima risponde con 200 e [].

Prova: premi Esegui e invia GET /api/tasks?page=2&pageSize=2: attività 3; la scheda Headers mostra X-Total-Count: 3. Invia GET /api/tasks?done=false&pageSize=1: attività 1 e X-Total-Count: 2. Invia GET /api/tasks?page=0&pageSize=99: 400 con entrambi gli errori.

Provalo tu

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 iconMettiti alla prova

Questa lezione include un breve quiz. Inizia la lezione per rispondere e tenere traccia dei tuoi progressi.

Tutte le lezioni di API REST