Menu
CoddyTech

מאפייני אימות

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

כתיבת כל כלל בתור if הופכת את הקוד לארוך. הערות נתונים מצמידות את הכללים לטיפוס בתור מאפיינים, מתוך System.ComponentModel.DataAnnotations, ו־Validator בודק אובייקט לפיהם.

record SignupInput(
    [property: Required, EmailAddress] string Email,
    [property: Range(13, 120)] int Age);

var results = new List<ValidationResult>();
Validator.TryValidateObject(input, new ValidationContext(input), results,
    validateAllProperties: true);

ברשומה מיקומית, property: מצמיד את המאפיין לתכונה, ושם Validator מחפש אותו. בלי validateAllProperties: true, נבדק רק [Required]. כל כלל שהופר מוסיף ValidationResult עם שם התכונה והודעה. ב־.NET 10 יש גם את builder.Services.AddValidation(), שבודק בשבילך פרמטרים של נקודות קצה, אבל עבור טיפוסים משלך הוא זקוק למחולל קוד מקור. סביבת ההרצה כאן לא מריצה מחוללי קוד מקור, ולכן צריך לקרוא ל־Validator בעצמך.

challenge icon

אתגר

בינוני

העבר את כללי הכותרת אל TaskInput והוסף כלל חדש: אורך הכותרת יהיה לכל היותר 80 תווים.

  1. יש לך קובץ חדש, Validation.cs. המתודה Errors שלו הופכת את התוצאות למילון ש-Results.ValidationProblem מקבלת. במקום שבו כתובה ההערה, קרא ל-Validator.TryValidateObject על model עם ValidationContext(model) חדש, עם results ועם validateAllProperties: true.
  2. בראש Program.cs, הוסף את using System.ComponentModel.DataAnnotations; והוסף ל-Title של TaskInput שתי תכונות: [property: Required(ErrorMessage = "Title is required."), StringLength(80)].
  3. בפעולות POST ו-PUT, החלף את הבדיקה של IsNullOrWhiteSpace ב-var errors = Validation.Errors(input);, והחזר את Results.ValidationProblem(errors) כאשר הערך אינו null.

כעת, כותרת באורך 81 תווים מחזירה 400 עם:

"errors": { "title": ["The field Title must be a string with a maximum length of 80."] }

נסה זאת: לחץ על „הרצה” ושלח בקשת POST עם גוף שהכותרת שלו מכילה 81 אותיות אל /api/tasks: מתקבלת תשובה 400 והשגיאה שלמעלה. שלח בקשת POST עם { "title": "" }: מתקבלת תשובה 400 עם Title is required., כמו קודם. שלח בקשת POST עם { "title": "Order new chairs" }: מתקבלת תשובה 201.

נסו בעצמכם

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) =>
{
    if (string.IsNullOrWhiteSpace(input.Title))
    {
        return Results.ValidationProblem(new Dictionary<string, string[]>
        {
            ["title"] = ["Title is required."],
        });
    }
    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) =>
{
    if (string.IsNullOrWhiteSpace(input.Title))
    {
        return Results.ValidationProblem(new Dictionary<string, string[]>
        {
            ["title"] = ["Title is required."],
        });
    }
    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);

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