Menu
CoddyTech

Attributs de validation

Fait partie de la section APIs REST du Journey ASP.NET Core de Coddy. Leçon 7 sur 20.

Écrire chaque règle sous forme de if devient vite long. Les annotations de données placent les règles sur le type sous forme d’attributs, depuis System.ComponentModel.DataAnnotations, et Validator vérifie un objet par rapport à celles-ci.

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

Dans un enregistrement positionnel, property: place l’attribut sur la propriété, là où Validator le recherche. Sans validateAllProperties: true, il vérifie uniquement [Required]. Chaque règle enfreinte ajoute un ValidationResult contenant le nom de la propriété et un message. .NET 10 propose également builder.Services.AddValidation(), qui vérifie les paramètres des points de terminaison pour vous, mais pour vos propres types, il nécessite un générateur de code source. L’environnement d’exécution utilisé ici n’exécute pas les générateurs de code source : vous devez donc appeler Validator vous-même.

challenge icon

Défi

Moyen

Déplace les règles du titre dans TaskInput et ajoute-en une nouvelle : un titre comporte au maximum 80 caractères.

  1. Tu as un nouveau fichier, Validation.cs. Sa méthode Errors transforme les résultats en dictionnaire attendu par Results.ValidationProblem. À l’endroit indiqué par le commentaire, appelle Validator.TryValidateObject sur model avec un nouveau ValidationContext(model), results et validateAllProperties: true.
  2. En haut de Program.cs, ajoute using System.ComponentModel.DataAnnotations; et attribue deux attributs à Title de TaskInput : [property: Required(ErrorMessage = "Title is required."), StringLength(80)].
  3. Dans POST et PUT, remplace la vérification IsNullOrWhiteSpace par var errors = Validation.Errors(input); et renvoie Results.ValidationProblem(errors) lorsque la valeur n’est pas null.

Un titre de 81 caractères renvoie maintenant 400 avec :

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

Essaie : appuie sur Run et envoie une requête POST avec un corps dont le titre contient 81 lettres à /api/tasks : 400 et l’erreur ci-dessus. Envoie { "title": "" } avec POST : 400 avec Title is required., comme avant. Envoie { "title": "Order new chairs" } avec POST : 201.

Essayez vous-même

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

Toutes les leçons de APIs REST