Menu
CoddyTech

Attributi di validazione

Fa parte della sezione API REST del percorso ASP.NET Core di Coddy. Lezione 7 di 20.

Scrivere ogni regola con un if rende il codice prolisso. Le annotazioni dei dati inseriscono le regole nel tipo come attributi, da System.ComponentModel.DataAnnotations, e Validator verifica un oggetto in base a esse.

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);

In un record posizionale, property: applica l'attributo alla proprietà, che è dove Validator lo cerca. Senza validateAllProperties: true controlla solo [Required]. Ogni regola non rispettata aggiunge un ValidationResult con il nome della proprietà e un messaggio. .NET 10 dispone anche di builder.Services.AddValidation(), che verifica per te i parametri degli endpoint, ma per i tuoi tipi ha bisogno di un generatore di codice sorgente. Il runner qui non esegue generatori di codice sorgente, quindi devi chiamare Validator personalmente.

challenge icon

Sfida

Medio

Sposta le regole del titolo in TaskInput e aggiungine una nuova: il titolo può avere al massimo 80 caratteri.

  1. Hai un nuovo file, Validation.cs. Il suo metodo Errors trasforma i risultati nel dizionario accettato da Results.ValidationProblem. Nel punto indicato dal commento, chiama Validator.TryValidateObject su model con un nuovo ValidationContext(model), results e validateAllProperties: true.
  2. All'inizio di Program.cs, aggiungi using System.ComponentModel.DataAnnotations; e assegna a Title di TaskInput due attributi: [property: Required(ErrorMessage = "Title is required."), StringLength(80)].
  3. In POST e PUT, sostituisci il controllo IsNullOrWhiteSpace con var errors = Validation.Errors(input); e restituisci Results.ValidationProblem(errors) quando non è null.

Un titolo di 81 caratteri ora restituisce 400 con:

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

Prova: premi Esegui e invia una richiesta POST con un corpo il cui titolo contiene 81 lettere a /api/tasks: 400 e l'errore qui sopra. Invia una richiesta POST con { "title": "" }: 400 con Title is required., come prima. Invia una richiesta POST con { "title": "Order new chairs" }: 201.

Provalo tu

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);

Tutte le lezioni di API REST