סדרי עדיפויות של משימות
חלק מהיחידה REST APIs במסלול ה-ASP.NET Core של Coddy. שיעור 14 מתוך 20.
הפרק הזה הוא פרויקט: מוסיפים תכונה דרך ה-API באמצעות מה שלמדת. יש משימות דחופות, ולכן לכל משימה יש עדיפות: 1 היא גבוהה, 2 רגילה, 3 נמוכה.
record Seat(int Row, [property: Range(1, 40)] int Number = 1);[Range(1, 40)] דוחה מספר מחוץ לטווח 1 עד 40 עם ההודעה The field Number must be between 1 and 40. ערך ברירת מחדל ברשומה positional (= 1) הוא הערך שגוף JSON שלא כולל את השדה מקבל. במאפיין שיכול להיות null, Range מאפשר ל-null לעבור, וזה מתאים ל-PATCH.
אתגר
בינוניתן לכל משימה עדיפות מ־1 (גבוהה) עד 3 (נמוכה). שמור על כל מה שבנית: כל נקודת קצה תמשיך לפעול כמו קודם.
- הוסף את
int Priority = 2כמאפיין האחרון שלTaskItem. תן למשימה 1 עדיפות 1 ולמשימה 2 עדיפות 3; משימה 3 תשמור על ברירת המחדל, 2. - הוסף את
[property: Range(1, 3)] int Priority = 2כמאפיין האחרון שלTaskInput, והעבר אתinput.Priorityל־TaskItemהחדש ב־POST וב־PUT. - הוסף את
[property: Range(1, 3)] int? Priorityל־TaskPatch. בתחילת PATCH, בדוק את התיקון באמצעותValidation.Errors(patch)והחזרResults.ValidationProblemאם נמצאו שגיאות. העתק את העדיפות ב־with, כמו את שאר השדות.
כל משימה נושאת כעת את העדיפות שלה: { "id": 1, "title": "Write the project brief", "done": false, "priority": 1 }. עדיפות 5 מחזירה 400 עם "errors": { "priority": ["The field Priority must be between 1 and 3."] }.
נסה זאת: לחץ על „הרצה”: לכל משימה ברשימה יש עדיפות. שלח POST עם { "title": "Order new chairs" }: העדיפות תהיה 2. שלח POST עם { "title": "Fix the printer", "priority": 5 }: תתקבל תשובת 400. שלח PATCH אל /api/tasks/3 עם { "priority": 1 }: משימה 3 תהפוך לדחופה ותשמור על הכותרת שלה.
נסו בעצמכם
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);