التعارضات
جزء من قسم واجهات API بنمط REST في رحلة ASP.NET Core على Coddy. الدرس 9 من 20.
إن إنشاء مستخدم ثانٍ يُدعى "Ada" يجعل تسجيلات الدخول ملتبسة، مع أن نص الطلب صالح. هذا هو تعارض 409 Conflict: يتعارض الطلب مع ما هو مخزّن بالفعل. تعني 400 أن نص الطلب نفسه غير صحيح؛ أما 409 فتعني أنه صحيح، لكن لا يمكن تطبيقه الآن.
bool NameTaken(string name, int exceptId) =>
users.Any(u => u.Id != exceptId &&
string.Equals(u.Name, name, StringComparison.OrdinalIgnoreCase));
if (NameTaken(input.Name, id))
return Results.Problem(title: "That name is taken.", statusCode: 409);يقرأ الناس "Ada" و"ada" على أنهما الاسم نفسه، لذا قارن باستخدام StringComparison.OrdinalIgnoreCase. عندما يعيد الطلب تسمية مستخدم، استثنِ ذلك المستخدم من البحث؛ وإلا فسيتعارض حفظ النموذج دون تغيير الاسم مع نفسه. يجيب Results.Problem بتنسيق تفاصيل المشكلة، متضمنًا العنوان والحالة اللذين تحددهما.
التحدي
متوسطوجود مهمتين باسم "Send the invoice" يجعل القائمة مربكة. ارفض أي عنوان موجود لمهمة أخرى.
- في
Program.cs، أسفلnextId، اكتب دالة محليةbool TitleTaken(string title, int exceptId): تكون قيمتها true عندما يكون العنوان لمهمة غيرexceptId، مع تجاهل حالة الأحرف. - في POST، بعد التحقق من الصحة، أرجع
Results.Problem(title: "A task with this title already exists.", statusCode: 409)عندما يكون العنوان مستخدمًا، ولا تضف شيئًا. ليس لدى POST مهمة لاستثنائها، لذا مرّر0. - افعل الشيء نفسه في PUT، مع تمرير
idالمهمة، حتى تتمكن المهمة من الاحتفاظ بعنوانها أو تغيير حالة أحرفه. - في PATCH، تحقّق فقط عندما يرسل الجسم عنوانًا (
patch.Titleليسnull).
الطلب المرفوض لا يغيّر شيئًا. محتوى الاستجابة 409 هو:
{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.10", "title": "A task with this title already exists.", "status": 409, "traceId": "..." }جرّب ذلك: اضغط على Run وأرسل POST بالبيانات { "title": "book the MEETING room" } إلى /api/tasks: تكون الاستجابة 409، لأن المهمة 2 لها هذا العنوان. أرسل PUT بالبيانات { "title": "Book the Meeting Room", "done": false } إلى /api/tasks/2: تكون الاستجابة 200، فهذا عنوان المهمة نفسها. أرسل PATCH إلى /api/tasks/3 مع { "title": "Write the project brief" }: تكون الاستجابة 409. أرسل POST بالبيانات { "title": "Order new chairs" }: تكون الاستجابة 201 مع المعرّف 4.
جرّب بنفسك
using System.ComponentModel.DataAnnotations;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddProblemDetails();
var app = builder.Build();
app.UseExceptionHandler();
app.UseStatusCodePages();
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);