Menu
CoddyTech

Pagination

Fait partie de la section APIs REST du Journey ASP.NET Core de Coddy. Leçon 13 sur 20.

Une API de commandes contenant 10 000 commandes ne peut pas toutes les renvoyer en une seule fois. La pagination renvoie une tranche : GET /api/orders?page=3&pageSize=20 correspond aux commandes 41 à 60. Le client a aussi besoin du nombre total pour afficher « page 3 sur 500 », et un en-tête le transmet sans modifier la structure du corps de la réponse.

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

Une valeur par défaut rend un paramètre de requête facultatif. Un paramètre HttpResponse correspond à la réponse en cours de construction : tu peux donc définir un en-tête avant de renvoyer la réponse. X-Total-Count compte les commandes correspondant aux filtres, avant la pagination. Refuse les pages dont le numéro est inférieur à 1 et plafonne la taille de page, afin qu’aucun client ne puisse tout demander en une seule fois.

challenge icon

Défi

Moyen

Réponds aux tâches une page à la fois et indique combien il y en a au total.

  1. Ajoute trois paramètres à la lambda GET /api/tasks, après sort : HttpResponse response, int page = 1 et int pageSize = 10.
  2. Dans le dictionnaire des erreurs, ajoute Page starts at 1. sous page lorsque page est inférieur à 1, et Page size is 1 to 50. sous pageSize lorsque pageSize est en dehors de l’intervalle 1 à 50.
  3. Après le filtrage et le tri, transforme le résultat en liste. Définis l’en-tête X-Total-Count avec le nombre d’éléments, puis renvoie uniquement la page : ignore (page - 1) * pageSize tâches et prends pageSize tâches.

GET /api/tasks?page=2&pageSize=2 renvoie uniquement la tâche 3, avec X-Total-Count: 3. Une page au-delà de la dernière renvoie 200 et [].

Essaie : appuie sur Exécuter et envoie GET /api/tasks?page=2&pageSize=2 : la tâche 3 ; l’onglet Headers affiche X-Total-Count: 3. Envoie GET /api/tasks?done=false&pageSize=1 : la tâche 1 et X-Total-Count: 2. Envoie GET /api/tasks?page=0&pageSize=99 : 400 avec les deux erreurs.

Essayez vous-même

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 iconTestez-vous

Cette leçon comprend un petit quiz. Commencez la leçon pour y répondre et suivre votre progression.

Toutes les leçons de APIs REST