Menu
CoddyTech

أولويات المهام

جزء من قسم واجهات API بنمط REST في رحلة 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.. القيمة الافتراضية في سجل موضعي (= 1) هي ما يحصل عليه نص JSON الذي لا يتضمن الحقل. في خاصية تقبل قيمة فارغة، يسمح Range بمرور null، وهذا مناسب لطلب PATCH.

challenge icon

التحدي

متوسط

امنح كل مهمة أولوية من 1 (عالية) إلى 3 (منخفضة). احتفظ بكل ما أنشأته: يظل كل مسار يعمل كما كان من قبل.

  1. أضف int Priority = 2 بوصفها الخاصية الأخيرة في TaskItem. امنح المهمة 1 الأولوية 1 والمهمة 2 الأولوية 3؛ وتحتفظ المهمة 3 بالقيمة الافتراضية، 2.
  2. أضف [property: Range(1, 3)] int Priority = 2 بوصفها الخاصية الأخيرة في TaskInput، ومرّر input.Priority إلى TaskItem الجديد في POST وPUT.
  3. أضف [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);

جميع دروس واجهات API بنمط REST