Menu
CoddyTech

الترتيب

جزء من قسم واجهات API بنمط REST في رحلة 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(...) فسيعيد ترتيب القائمة المخزنة نفسها، لذا ستُعاد كل إجابة لاحقة بالترتيب الجديد أيضًا. يتيح جمع الأخطاء في قاموس واحد إبلاغ الطلب الذي يتضمن عدة أخطاء بها كلها دفعة واحدة.

challenge icon

التحدي

سهل

أتِح للعملاء ترتيب المهام حسب العنوان.

  1. أضف المعامل الثالث string? sort إلى لامبدا GET /api/tasks.
  2. في بداية لامبدا، اجمع الأخطاء في قاموس. عندما لا تكون sort هي null أو id أو title، أضف Sort by id or title. تحت sort، وأعِد Results.ValidationProblem(errors) عندما يحتوي القاموس على أي أخطاء.
  3. بعد عوامل التصفية، عندما تكون 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);

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