Menu
CoddyTech

Konflikte

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

Ein zweiter Benutzer namens „Ada“ macht Anmeldungen mehrdeutig, obwohl der Textkörper gültig ist. Das ist 409 Conflict: Die Anfrage steht im Konflikt mit dem, was bereits gespeichert ist. Ein 400 bedeutet, dass der Textkörper selbst fehlerhaft ist; ein 409 bedeutet, dass er in Ordnung ist, aber jetzt nicht angewendet werden kann.

bool NameTaken(string name, int exceptId) =>
    users.Any(u => u.Id != exceptId &&
        string.Equals(u.Name, name, StringComparison.OrdinalIgnoreCase));

if (NameTaken(input.Name, id))
    return Results.Problem(title: "That name is taken.", statusCode: 409);

Menschen lesen „Ada“ und „ada“ als denselben Namen, also vergleiche mit StringComparison.OrdinalIgnoreCase. Wenn eine Anfrage den Namen eines Benutzers ändert, lass diesen Benutzer bei der Suche außen vor: Andernfalls steht das Speichern eines Formulars ohne Namensänderung mit sich selbst im Konflikt. Results.Problem antwortet im Format der Problemdetails mit deinem Titel und Status.

challenge icon

Aufgabe

Mittel

Zwei Aufgaben mit dem Titel "Send the invoice" machen die Liste unübersichtlich. Lehne einen Titel ab, den eine andere Aufgabe bereits hat.

  1. Schreibe in Program.cs unter nextId eine lokale Funktion bool TitleTaken(string title, int exceptId): Sie ist wahr, wenn eine andere Aufgabe als exceptId den Titel hat, unabhängig von Groß- und Kleinschreibung.
  2. Gib in POST nach der Validierungsprüfung Results.Problem(title: "A task with this title already exists.", statusCode: 409) zurück, wenn der Titel bereits vergeben ist, und füge nichts hinzu. POST hat keine Aufgabe, die ausgeschlossen werden muss, also übergib 0.
  3. Mach dasselbe in PUT und übergib die id der Aufgabe, damit eine Aufgabe ihren eigenen Titel behalten oder dessen Groß- und Kleinschreibung ändern kann.
  4. Prüfe in PATCH nur dann, wenn der Request-Body einen Titel enthält (patch.Title ist nicht null).

Eine abgelehnte Anfrage ändert nichts. Der 409-Body lautet:

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.10", "title": "A task with this title already exists.", "status": 409, "traceId": "..." }

Probiere es aus: Klicke auf „Ausführen“ und sende per POST { "title": "book the MEETING room" } an /api/tasks: 409, weil Aufgabe 2 diesen Titel hat. Sende per PUT { "title": "Book the Meeting Room", "done": false } an /api/tasks/2: 200, da es der eigene Titel ist. Sende per PATCH an /api/tasks/3 den Inhalt { "title": "Write the project brief" }: 409. Sende per POST { "title": "Order new chairs" }: 201 mit id 4.

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;

app.MapGet("/api/tasks", () => tasks);

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