Priorytety zadań
Część sekcji API REST ścieżki ASP.NET Core w Coddy. Lekcja 14 z 20.
Ten rozdział to projekt: dodajesz funkcję w całym API, wykorzystując to, czego się nauczyłeś. Niektóre zadania są pilne, więc każde zadanie otrzymuje priorytet: 1 oznacza wysoki, 2 normalny, 3 niski.
record Seat(int Row, [property: Range(1, 40)] int Number = 1);[Range(1, 40)] odrzuca liczby spoza zakresu od 1 do 40, wyświetlając komunikat The field Number must be between 1 and 40. Wartość domyślna w rekordzie pozycyjnym (= 1) jest wartością, którą otrzymuje treść JSON, gdy pomija to pole. W przypadku właściwości dopuszczającej null Range przepuszcza null, co sprawdza się przy PATCH.
Wyzwanie
ŚredniPrzypisz każdemu zadaniu priorytet od 1 (wysoki) do 3 (niski). Zachowaj wszystko, co zostało zbudowane: każdy endpoint nadal działa tak jak wcześniej.
- Dodaj
int Priority = 2jako ostatnią właściwośćTaskItem. Przypisz zadaniu 1 priorytet 1, a zadaniu 2 priorytet 3; zadanie 3 zachowuje domyślną wartość 2. - Dodaj
[property: Range(1, 3)] int Priority = 2jako ostatnią właściwośćTaskInputi przekażinput.Prioritydo nowegoTaskItemw POST i PUT. - Dodaj
[property: Range(1, 3)] int? PrioritydoTaskPatch. Na początku PATCH sprawdź patch za pomocąValidation.Errors(patch)i zwróćResults.ValidationProblem, jeśli zostaną znalezione błędy. Skopiuj priorytet wwith, tak jak pozostałe pola.
Każde zadanie ma teraz przypisany priorytet: { "id": 1, "title": "Write the project brief", "done": false, "priority": 1 }. Priorytet 5 zwraca kod 400 z "errors": { "priority": ["The field Priority must be between 1 and 3."] }.
Wypróbuj: naciśnij „Uruchom”: każde zadanie na liście ma priorytet. POST { "title": "Order new chairs" }: priorytet 2. POST { "title": "Fix the printer", "priority": 5 }: 400. PATCH /api/tasks/3 z { "priority": 1 }: zadanie 3 staje się pilne i zachowuje swój tytuł.
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),
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);