דחיית קלט שגוי
חלק מהיחידה REST APIs במסלול ה-ASP.NET Core של Coddy. שיעור 6 מתוך 20.
אפשר לקשור גוף בקשה ועדיין לקבל נתונים חסרי היגיון: כתובת דוא״ל ריקה, מחיר שלילי. החזר 400 Bad Request וציין מה שגוי במבנה שהלקוחות יכולים לקרוא. Results.ValidationProblem מקבלת מילון משמות שדות להודעות:
if (string.IsNullOrWhiteSpace(input.Email))
{
return Results.ValidationProblem(new Dictionary<string, string[]>
{
["email"] = ["Email is required."],
});
}היא מחזירה 400 עם סוג התוכן application/problem+json ועם גוף זה:
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"errors": { "email": ["Email is required."] } }בדוק לפני שאתה משנה משהו, כדי שבקשה שנדחתה תשאיר את הנתונים כפי שהיו. גוף שאינו JSON תקין לעולם לא יגיע ל-lambda שלך: ASP.NET Core מחזיר עבורו 400.
אתגר
קלכרגע, POST /api/tasks עם { "title": "" } מוסיף משימה ללא כותרת. צריך לדחות אותה.
- בתחילת הלמבדה של
POST /api/tasks, לפניnextId++, בדוק את הכותרת באמצעותstring.IsNullOrWhiteSpace(input.Title). כך מזהים כותרת חסרה (null), כותרת ריקה וכותרת שמורכבת מרווחים. - אם הבדיקה נכשלת, החזר
Results.ValidationProblemעם השדהtitleוההודעהTitle is required., כך שגוף התגובה יכיל:"errors": { "title": ["Title is required."] } - הוסף את אותה בדיקה בתחילת הלמבדה של
PUT /api/tasks/{id:int}.
נסה זאת: לחץ על „הרצה” ושלח POST עם { "title": "" } אל /api/tasks: מתקבלת תגובת 400 והשגיאות שלמעלה. שלח GET /api/tasks: עדיין יש שלוש משימות. שלח PUT עם { "title": " ", "done": true } אל /api/tasks/1: מתקבלת תגובת 400, והכותרת של משימה 1 נשארת ללא שינוי. שלח POST עם { "title": "Order new chairs" }: מתקבלת תגובת 201 עם המזהה 4.
נסו בעצמכם
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.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(string Title, bool Done);
record TaskPatch(string? Title, bool? Done);
השיעור הזה כולל חידון קצר. התחילו את השיעור כדי לענות עליו ולעקוב אחרי ההתקדמות.