Xóa các tác vụ đã hoàn thành
Thuộc phần REST API trong hành trình ASP.NET Core của Coddy. Bài học 16 trên 20.
DELETE cũng có thể gửi đến một collection và xóa mọi mục khớp với truy vấn. Cách này chỉ cần một request thay vì một request cho mỗi mục, nhưng chỉ cần một lỗi đánh máy là có thể xóa sạch mọi thứ. Hãy để client nói chính xác ý định của mình.
app.MapDelete("/api/messages", (bool? read) =>
{
if (read != true) return Results.ValidationProblem(errors);
messages.RemoveAll(m => m.Read);
return Results.NoContent();
});Nếu không có ?read=true, request sẽ bị từ chối và không có gì bị xóa. Các mẫu route khác nhau, nên endpoint này nằm cạnh DELETE /api/messages/{id:int} mà không bị xung đột.
Thử thách
DễCho phép client xóa các tác vụ đã hoàn thành trong một yêu cầu. Giữ nguyên DELETE /api/tasks/{id:int}.
- Ánh xạ
DELETE /api/tasksvới tham sốbool? done. - Nếu
donekhông phải làtrue, hãy trả vềResults.ValidationProblemvới nội dungAdd ?done=true to delete the done tasks.dưới khóadone, và không xóa gì cả. - Nếu không, hãy xóa mọi tác vụ có
Donelà true và trả vềResults.NoContent().
Thử nhé: nhấn Chạy, chọn DELETE, đường dẫn /api/tasks?done=true, rồi nhấn Gửi: 204. Gửi GET /api/tasks: chỉ còn tác vụ 1 và 3. Gửi DELETE /api/tasks không có truy vấn: 400 và lỗi ở trên. POST { "title": "Order new chairs" }: tác vụ nhận id 4 vì các id không bao giờ được dùng lại.
Tự làm thử
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);
Tất cả bài học trong REST API
1Tài nguyên và động từ
Tài nguyên và URLTạo mới bằng POST4Dự án: Mức độ ưu tiên
Mức độ ưu tiên của tác vụ