Menu
CoddyTech

פרטי הבעיה

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

גוף ריק של 404 משאיר את הלקוח לנחש מה השתבש. פרטי בעיה (RFC 9457) הוא מבנה JSON תקני לשגיאה, שנשלח עם סוג התוכן application/problem+json. התשובות שלכם עם קוד 400 כבר משתמשות בו. ב-API של הזמנות, שלוש שורות מעניקות לכל שגיאה מבנה זהה:

builder.Services.AddProblemDetails();
var app = builder.Build();

app.UseExceptionHandler();
app.UseStatusCodePages();

כעת, בקשה מסוג GET /api/orders/7 עבור הזמנה חסרה מחזירה 404 עם:

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "title": "Not Found", "status": 404,
  "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00" }

AddProblemDetails רושם את השירות שכותב את המבנה. UseStatusCodePages מוסיף גוף של בעיה לכל תשובת שגיאה שאין לה גוף כזה, בין אם היא מגיעה מ-Results.NotFound() ובין אם מנתיב שאין לו מסלול. UseExceptionHandler הופך חריגה שלא טופלה לבעיית 500. traceId חדש בכל בקשה; הוא מקשר בין התשובה לבין יומני השרת.

challenge icon

אתגר

קל

תן לשגיאות של מנהל המשימות מבנה אחיד, כדי שלקוח יוכל לקרוא כל כשל באותה צורה.

  1. ב־Program.cs, בשורה שלפני builder.Build(), הוסף builder.Services.AddProblemDetails();
  2. מיד אחרי builder.Build(), הוסף app.UseExceptionHandler(); ולאחר מכן app.UseStatusCodePages();, לפני כל נקודת קצה.

אל תשנה שום דבר אחר: נקודות הקצה שלך ימשיכו להשיב Results.NotFound(), ותווכת הביניים תמלא את גוף התשובה. לאחר מכן, GET /api/tasks/99 משיב 404 עם סוג התוכן application/problem+json ועם:

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5", "title": "Not Found", "status": 404, "traceId": "..." }

נסה זאת: לחץ על הרצה ושלח GET /api/tasks/99: תקבל את תגובת 404 שלמעלה. שלח GET /api/projects, נתיב שאין לו נתיב תואם: אותו מבנה. שלח POST עם { "title": "" } אל /api/tasks: תגובת 400 שלך תשמור על errors שלה, ותתווסף לה traceId.

נסו בעצמכם

using System.ComponentModel.DataAnnotations;

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 errors = Validation.Errors(input);
    if (errors is not null) return Results.ValidationProblem(errors);
    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();
    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();
    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);
quiz iconבחנו את עצמכם

השיעור הזה כולל חידון קצר. התחילו את השיעור כדי לענות עליו ולעקוב אחרי ההתקדמות.

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