التحديثات الجزئية باستخدام PATCH
جزء من قسم واجهات API بنمط REST في رحلة ASP.NET Core على Coddy. الدرس 4 من 20.
يغيّر PATCH الحقول التي يرسلها جسم الطلب فقط. لتمييز الحقل الذي لم يُرسَل عن الحقل الذي أُسنِدت إليه قيمة، اجعل كل خاصية في سجل التعديل قابلة لأن تكون فارغة: يرتبط الحقل المفقود بـ null.
record ProfilePatch(string? Name, string? City);
profiles[index] = profile with
{
Name = patch.Name ?? profile.Name,
City = patch.City ?? profile.City,
};تنسخ with سجلًا وتغيّر الخصائص التي تحددها. تُبقي ?? القيمة القديمة عندما يحتوي التعديل على null. تعمل bool? بالطريقة نفسها: false قيمة أرسلها العميل، وnull يعني أنه لم يرسل شيئًا. لذا ينقل { "city": "Lyon" } الملف الشخصي إلى مدينة أخرى ويُبقي اسمه.
التحدي
سهلأتِح للعملاء تغيير حقل واحد من المهمة، مثل تحديدها على أنها منجزة، دون إرسال العنوان مرة أخرى.
- في أسفل
Program.cs، عرّفrecord TaskPatch(string? Title, bool? Done); - اربط
PATCH /api/tasks/{id:int}معint idوTaskPatch patch. أعدResults.NotFound()عندما لا توجد مهمة لها هذا المعرّف. - وإلا، فخزّن نسخة من المهمة باستخدام
with، بحيث تأخذ كل خاصية قيمة الرقعة، أو تحتفظ بقيمة المهمة نفسها إذا كانت قيمة الرقعةnull. أعد المهمة بعد تغييرها باستخدامResults.Ok.
يرد PATCH /api/tasks/1 مع { "done": true } بالرمز 200 وبما يلي:
{ "id": 1, "title": "Write the project brief", "done": true }جرّب ذلك: اضغط على «تشغيل»، واختر PATCH، والمسار /api/tasks/1، ومتن الطلب { "done": true }، ثم اضغط على «إرسال»: ستكون الإجابة كما في الأعلى، مع الاحتفاظ بالعنوان. أرسل PATCH إلى /api/tasks/2 مع { "title": "Book the big room" }: سيظهر العنوان الجديد، وستبقى "done": true. يرد PATCH إلى /api/tasks/99 بالرمز 404.
جرّب بنفسك
var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();
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;
app.MapGet("/api/tasks", () => tasks);
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 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 index = tasks.FindIndex(t => t.Id == id);
if (index == -1) return Results.NotFound();
tasks[index] = new TaskItem(id, input.Title, input.Done);
return Results.Ok(tasks[index]);
});
app.Run();
record TaskItem(int Id, string Title, bool Done);
record TaskInput(string Title, bool Done);
يتضمن هذا الدرس اختبارًا قصيرًا. ابدأ الدرس للإجابة عليه وتتبّع تقدمك.
جميع دروس واجهات API بنمط REST
1الموارد والأفعال
الموارد وURLsالإنشاء باستخدام POST