Menu
CoddyTech

החלפה באמצעות PUT

חלק מהיחידה REST APIs במסלול ה-ASP.NET Core של Coddy. שיעור 3 מתוך 20.

PUT מחליף פריט. גוף הבקשה הוא המצב החדש המלא של הפריט, והוא נשלח לכתובת ה-URL של הפריט עצמו. שדה שהגוף לא כולל יקבל את ערך ברירת המחדל שלו. שליחת אותה בקשת PUT פעמיים נותנת את אותה תוצאה, ולכן PUT היא אידמפוטנטית: לקוח יכול לנסות שוב אחרי פקיעת זמן ההמתנה. POST אינה אידמפוטנטית, משום ששליחת בקשת POST שנייה מוסיפה פריט שני.

app.MapPut("/api/products/{id:int}", (int id, ProductInput input) =>
{
    var index = products.FindIndex(p => p.Id == id);
    if (index == -1) return Results.NotFound();
    products[index] = new Product(id, input.Name, input.Price);
    return Results.Ok(products[index]);
});

ה-id מגיע מנתיב הכתובת, לעולם לא מגוף הבקשה, ולכן לקוח אינו יכול להעביר מוצר ל-id אחר. FindIndex מחזירה את המיקום של הפריט ברשימה, או ‎-1 אם אין התאמה, ו-products[index] = ... שומר את הגרסה החדשה במקומו.

challenge icon

אתגר

קל

אפשר ללקוחות להחליף משימה.

  1. ב־Program.cs, מיפוי PUT /api/tasks/{id:int} עם פרמטרים int id ו־TaskInput input. למבנה גוף הבקשה יש אותה צורה כמו לגוף בקשת POST.
  2. מציאת מיקום המשימה באמצעות tasks.FindIndex. כשהערך הוא -1, החזרה של Results.NotFound() ואי־הוספה של דבר.
  3. אחרת, שמירת new TaskItem(id, input.Title, input.Done) במיקום הזה והחזרתו באמצעות Results.Ok. הבקשה PUT /api/tasks/1 עם { "title": "Write the final brief", "done": true } מחזירה 200 ואת התוצאה:
    { "id": 1, "title": "Write the final brief", "done": true }

נסו זאת: לחצו על הרצה, בחרו PUT, הזינו את הנתיב /api/tasks/1, את הגוף שלמעלה, ולחצו על שליחה: מתקבלים 200 והמשימה שלמעלה. שלחו GET /api/tasks/1: הכותרת החדשה. שלחו PUT אל /api/tasks/2 עם { "title": "Book the big room" }: משימה 2 הושלמה, אבל הגוף לא כלל את done, ולכן התשובה כוללת "done": false. בקשת PUT אל /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.Run();

record TaskItem(int Id, string Title, bool Done);
record TaskInput(string Title, bool Done);

כל השיעורים ביחידה REST APIs