Menu
CoddyTech

Seitennavigation

Teil des Abschnitts REST-APIs der ASP.NET Core-Journey von Coddy. Lektion 13 von 20.

Eine Bestellungs-API mit 10.000 Bestellungen kann nicht alle auf einmal beantworten. Die Paginierung liefert einen Ausschnitt: GET /api/orders?page=3&pageSize=20 umfasst die Bestellungen 41 bis 60. Der Client benötigt außerdem die Gesamtzahl, um „Seite 3 von 500“ anzuzeigen, und ein Header übermittelt sie, ohne die Struktur des Bodys zu ändern.

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

Ein Standardwert macht einen Abfrageparameter optional. Ein Parameter vom Typ HttpResponse ist die Antwort, die erstellt wird. Daher kannst du einen Header festlegen, bevor du die Antwort zurückgibst. X-Total-Count zählt die Bestellungen, die den Filtern entsprechen, bevor die Paginierung angewendet wird. Weise eine Seite unter 1 zurück und begrenze die Seitengröße, damit kein Client alles auf einmal anfordern kann.

challenge icon

Aufgabe

Mittel

Beantworte die Aufgaben eine Seite nach der anderen und gib an, wie viele es insgesamt gibt.

  1. Füge dem Lambda-Ausdruck für GET /api/tasks nach sort drei Parameter hinzu: HttpResponse response, int page = 1 und int pageSize = 10.
  2. Füge im Fehlerverzeichnis unter page den Eintrag Page starts at 1. hinzu, wenn page kleiner als 1 ist, und unter pageSize den Eintrag Page size is 1 to 50., wenn pageSize außerhalb des Bereichs von 1 bis 50 liegt.
  3. Wandle das Ergebnis nach dem Filtern und Sortieren in eine Liste um. Setze den Header X-Total-Count auf deren Anzahl und gib dann nur die Seite zurück: Überspringe (page - 1) * pageSize Aufgaben und nimm pageSize.

GET /api/tasks?page=2&pageSize=2 gibt nur Aufgabe 3 zurück, mit X-Total-Count: 3. Eine Seite hinter dem Ende gibt den Status 200 und [] zurück.

Probiere es aus: Klicke auf „Ausführen“ und sende GET /api/tasks?page=2&pageSize=2: Aufgabe 3; im Reiter „Kopfzeilen“ wird X-Total-Count: 3 angezeigt. Sende GET /api/tasks?done=false&pageSize=1: Aufgabe 1 und X-Total-Count: 2. Sende GET /api/tasks?page=0&pageSize=99: Status 400 mit beiden Fehlern.

Probier es selbst

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 dich selbst

Diese Lektion enthält ein kurzes Quiz. Starte die Lektion, um es zu beantworten und deinen Fortschritt zu speichern.

Alle Lektionen in REST-APIs