מיון
חלק מהיחידה REST APIs במסלול ה-ASP.NET Core של Coddy. שיעור 12 מתוך 20.
פרמטר sort מאפשר ללקוח לבחור את סדר המיון: GET /api/products?sort=price. קבלו רק את אפשרויות המיון שבהן אתם תומכים, והשיבו 400 לכל אפשרות אחרת, כדי שדבר שגוי כמו sort=prise ידווח במקום להתעלם ממנו.
var errors = new Dictionary<string, string[]>();
if (sort is not null && sort != "name" && sort != "price")
errors["sort"] = ["Sort by name or price."];
if (errors.Count > 0) return Results.ValidationProblem(errors);
if (sort == "price") result = result.OrderBy(p => p.Price);OrderBy מחזירה רצף חדש וממויין, ומשאירה את הרשימה כפי שהיא. products.Sort(...) היה משנה את סדר הרשימה השמורה עצמה, כך שגם כל תשובה מאוחרת יותר הייתה חוזרת באותו סדר חדש. ריכוז השגיאות במילון אחד מאפשר לבקשה עם כמה טעויות לקבל דיווח על כולן בבת אחת.
אתגר
קלאפשר ללקוחות למיין את המשימות לפי הכותרת.
- תן ל-lambda של
GET /api/tasksפרמטר שלישי,string? sort. - בתחילת ה-lambda, אסוף שגיאות במילון. כאשר
sortאינוnull,idאוtitle, הוסף אתSort by id or title.תחתsort, והשב באמצעותResults.ValidationProblem(errors)כאשר המילון מכיל שגיאות. - אחרי המסננים, כאשר
sortהואtitle, מיין את התוצאה לפי הכותרת באמצעותOrderBy. ללאsort, או עםsort=id, המשימות נשארות לפי סדר המזהים.
GET /api/tasks?sort=title מחזיר את המשימות 2, 3 ו-1: Book, Send, Write.
נסה זאת: לחץ על הרצה ושלח GET /api/tasks?sort=title: הסדר שמופיע למעלה. שלח GET /api/tasks: חזרה לסדר לפי מזהים. שלח GET /api/tasks?sort=size: שגיאת 400 עם "errors": { "sort": ["Sort by id or title."] }. שלח GET /api/tasks?done=false&sort=title: המשימות 3 ו-1.
נסו בעצמכם
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) =>
{
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));
return Results.Ok(result);
});
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);