עדכונים חלקיים באמצעות PATCH
חלק מהיחידה REST APIs במסלול ה-ASP.NET Core של Coddy. שיעור 4 מתוך 20.
PATCH משנה רק את השדות שהגוף שולח. כדי להבחין בין שדה שהושמט לבין שדה שקיבל ערך, הגדירו כל מאפיין ברשומת התיקון כמאפיין שיכול לקבל ערך null: שדה חסר נקשר ל־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);
השיעור הזה כולל חידון קצר. התחילו את השיעור כדי לענות עליו ולעקוב אחרי ההתקדמות.
כל השיעורים ביחידה REST APIs
1משאבים ופעלים
משאבים וכתובות URLיצירה באמצעות POST