עימוד
חלק מהיחידה REST APIs במסלול ה-ASP.NET Core של Coddy. שיעור 13 מתוך 20.
ממשק API להזמנות עם 10,000 הזמנות לא יכול להחזיר את כולן בבת אחת. עימוד מחזיר חלק אחד: GET /api/orders?page=3&pageSize=20 הן ההזמנות 41 עד 60. הלקוח זקוק גם למספר הכולל, כדי להציג "עמוד 3 מתוך 500", וכותרת מעבירה אותו בלי לשנות את מבנה גוף התשובה.
app.MapGet("/api/orders", (HttpResponse response, int page = 1, int pageSize = 20) =>
{
var matching = orders.ToList();
response.Headers["X-Total-Count"] = matching.Count.ToString();
return Results.Ok(matching.Skip((page - 1) * pageSize).Take(pageSize));
});ערך ברירת מחדל הופך פרמטר שאילתה לאופציונלי. פרמטר מסוג HttpResponse הוא התשובה שנבנית, ולכן אפשר להגדיר כותרת לפני שמחזירים אותה. X-Total-Count סופר את ההזמנות שתואמות למסננים, לפני העימוד. דחה עמוד שמספרו קטן מ־1 והגבל את גודל העמוד, כדי שאף לקוח לא יוכל לבקש הכול בבת אחת.
אתגר
בינוניענו על המשימות עמוד אחד בכל פעם וציינו כמה משימות יש בסך הכול.
- הוסיפו שלושה פרמטרים ל-lambda של
GET /api/tasks, אחריsort:HttpResponse response,int page = 1ו-int pageSize = 10. - במילון השגיאות, הוסיפו את
Page starts at 1.תחתpageכאשרpageקטן מ-1, ואתPage size is 1 to 50.תחתpageSizeכאשרpageSizeמחוץ לטווח 1 עד 50. - אחרי הסינון והמיון, הפכו את התוצאה לרשימה. הגדירו את הכותרת
X-Total-Countלמספר הפריטים שבה, ואז החזירו רק את העמוד: דלגו על(page - 1) * pageSizeמשימות וקחוpageSize.
GET /api/tasks?page=2&pageSize=2 מחזיר רק את משימה 3, עם X-Total-Count: 3. עמוד שמעבר לסוף הרשימה מחזיר 200 ואת [].
נסו זאת: לחצו על Run ושלחו GET /api/tasks?page=2&pageSize=2: משימה 3, ובכרטיסייה Headers מופיע X-Total-Count: 3. שלחו GET /api/tasks?done=false&pageSize=1: משימה 1 ו-X-Total-Count: 2. שלחו GET /api/tasks?page=0&pageSize=99: מתקבלת שגיאת 400 עם שתי השגיאות.
נסו בעצמכם
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) =>
{
var errors = new Dictionary<string, string[]>();
if (sort is not null && sort != "id" && sort != "title")
errors["sort"] = ["Sort by id or title."];
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);
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);
השיעור הזה כולל חידון קצר. התחילו את השיעור כדי לענות עליו ולעקוב אחרי ההתקדמות.