Menu
CoddyTech

Usuwanie wykonanych zadań

Część sekcji API REST ścieżki ASP.NET Core w Coddy. Lekcja 16 z 20.

Żądanie DELETE może dotyczyć również kolekcji i usuwać każdy element pasujący do zapytania. To jedno żądanie zamiast osobnego dla każdego elementu, ale wystarczy jedna literówka, by usunąć wszystko. Klient powinien dokładnie określać, co ma na myśli.

app.MapDelete("/api/messages", (bool? read) =>
{
    if (read != true) return Results.ValidationProblem(errors);
    messages.RemoveAll(m => m.Read);
    return Results.NoContent();
});

Bez ?read=true żądanie zostaje odrzucone i nic nie zostaje usunięte. Wzorce tras się różnią, dlatego ten punkt końcowy działa obok DELETE /api/messages/{id:int} bez konfliktu.

challenge icon

Wyzwanie

Łatwy

Pozwól klientom usuwać ukończone zadania w jednym żądaniu. Pozostaw DELETE /api/tasks/{id:int} bez zmian.

  1. Mapuj DELETE /api/tasks z parametrem bool? done.
  2. Jeśli done nie ma wartości true, zwróć Results.ValidationProblem z komunikatem Add ?done=true to delete the done tasks. dla pola done i nie usuwaj żadnych zadań.
  3. W przeciwnym razie usuń każde zadanie, którego Done ma wartość true, i zwróć Results.NoContent().

Wypróbuj: naciśnij „Uruchom”, wybierz DELETE, ścieżkę /api/tasks?done=true i naciśnij „Wyślij”: 204. Wyślij GET /api/tasks: pozostaną zadania 1 i 3. Wyślij żądanie DELETE do /api/tasks bez parametrów zapytania: 400 i powyższy błąd. Wyślij żądanie POST z { "title": "Order new chairs" }: zadanie otrzyma id 4, ponieważ identyfikatory nigdy nie są używane ponownie.

Spróbuj swoich sił

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, 1),
    new(2, "Book the meeting room", true, 3),
    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, int? priority, 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" && sort != "priority")
        errors["sort"] = ["Sort by id, title or priority."];
    if (priority is < 1 or > 3)
        errors["priority"] = ["Priority is 1 to 3."];
    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 (priority is not null) result = result.Where(t => t.Priority == priority);
    if (sort == "title") result = result.OrderBy(t => t.Title);
    if (sort == "priority") result = result.OrderBy(t => t.Priority);

    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, input.Priority);
    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, input.Priority);
    return Results.Ok(tasks[index]);
});

app.MapPatch("/api/tasks/{id:int}", (int id, TaskPatch patch) =>
{
    var errors = Validation.Errors(patch);
    if (errors is not null) return Results.ValidationProblem(errors);
    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,
        Priority = patch.Priority ?? task.Priority,
    };
    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, int Priority = 2);
record TaskInput(
    [property: Required(ErrorMessage = "Title is required."), StringLength(80)] string Title,
    bool Done,
    [property: Range(1, 3)] int Priority = 2);
record TaskPatch(string? Title, bool? Done, [property: Range(1, 3)] int? Priority);

Wszystkie lekcje w sekcji API REST