رفض المدخلات غير الصالحة
جزء من قسم واجهات API بنمط REST في رحلة 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": "" } إلى إضافة مهمة بلا عنوان. ارفض ذلك.
- في بداية دالة lambda الخاصة بـ
POST /api/tasks، وقبلnextId++، تحقّق من العنوان باستخدامstring.IsNullOrWhiteSpace(input.Title). فهذا يكشف العنوان المفقود (null)، والعنوان الفارغ، والعنوان المكوّن من مسافات. - عند فشل التحقق، أجب باستخدام
Results.ValidationProblemمع الحقلtitleوالرسالةTitle is required.، بحيث يحتوي المتن على:"errors": { "title": ["Title is required."] } - أضف التحقق نفسه في بداية دالة lambda الخاصة بـ
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);
يتضمن هذا الدرس اختبارًا قصيرًا. ابدأ الدرس للإجابة عليه وتتبّع تقدمك.