Menu
CoddyTech

Aufgabenprioritäten

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

Dieses Kapitel ist ein Projekt: Du fügst mithilfe des Gelernten ein Feature in der gesamten API hinzu. Manche Aufgaben sind dringend, daher erhält jede Aufgabe eine Priorität: 1 ist hoch, 2 normal, 3 niedrig.

record Seat(int Row, [property: Range(1, 40)] int Number = 1);

[Range(1, 40)] weist eine Zahl außerhalb des Bereichs von 1 bis 40 mit der Meldung The field Number must be between 1 and 40. zurück. Ein Standardwert in einem positionsbezogenen Record (= 1) ist der Wert, den ein JSON-Body erhält, wenn das Feld darin fehlt. Bei einer nullable Property lässt Range den Wert null durch, was für ein PATCH passend ist.

challenge icon

Aufgabe

Mittel

Gib jeder Aufgabe eine Priorität von 1 (hoch) bis 3 (niedrig). Behalte alles bei, was du erstellt hast: Jeder Endpunkt funktioniert weiterhin wie zuvor.

  1. Füge int Priority = 2 als letzte Eigenschaft von TaskItem hinzu. Weise Aufgabe 1 die Priorität 1 und Aufgabe 2 die Priorität 3 zu; Aufgabe 3 behält den Standardwert 2.
  2. Füge [property: Range(1, 3)] int Priority = 2 als letzte Eigenschaft von TaskInput hinzu und übergib input.Priority in POST und PUT an das neue TaskItem.
  3. Füge [property: Range(1, 3)] int? Priority zu TaskPatch hinzu. Prüfe zu Beginn von PATCH den Patch mit Validation.Errors(patch) und gib Results.ValidationProblem zurück, wenn Fehler gefunden werden. Übernimm die Priorität in das with, wie bei den anderen Feldern.

Jede Aufgabe enthält jetzt ihre Priorität: { "id": 1, "title": "Write the project brief", "done": false, "priority": 1 }. Bei einer Priorität von 5 wird der Statuscode 400 mit "errors": { "priority": ["The field Priority must be between 1 and 3."] } zurückgegeben.

Probiere es aus: Klicke auf „Ausführen“: Jede Aufgabe in der Liste hat eine Priorität. POST { "title": "Order new chairs" }: Priorität 2. POST { "title": "Fix the printer", "priority": 5 }: 400. PATCH /api/tasks/3 mit { "priority": 1 }: Aufgabe 3 wird dringend und behält ihren Titel.

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, HttpResponse response, int page = 1, int pageSize = 10) =>
{
    var errors = new Dictionary<string, string[]>();
    if (sort is not null && sort != "id" && sort != "title")
        errors["sort"] = ["Sort by id or title."];
    if (page < 1)
        errors["page"] = ["Page starts at 1."];
    if (pageSize < 1 || pageSize > 50)
        errors["pageSize"] = ["Page size is 1 to 50."];
    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);

    var matching = result.ToList();
    response.Headers["X-Total-Count"] = matching.Count.ToString();
    return Results.Ok(matching.Skip((page - 1) * pageSize).Take(pageSize));
});

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

Alle Lektionen in REST-APIs