Atributos de validação
Parte da seção APIs REST do Journey de ASP.NET Core da Coddy. Lição 7 de 20.
Escrever cada regra como um if fica longo. Anotações de dados colocam as regras no tipo como atributos, de System.ComponentModel.DataAnnotations, e Validator verifica um objeto com base nelas.
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);Em um registro posicional, property: coloca o atributo na propriedade, que é onde Validator procura. Sem validateAllProperties: true, ele verifica apenas [Required]. Cada regra violada adiciona um ValidationResult com o nome da propriedade e uma mensagem. O .NET 10 também tem builder.Services.AddValidation(), que verifica os parâmetros dos endpoints para você, mas, para seus próprios tipos, precisa de um gerador de código-fonte. O executor daqui não executa geradores de código-fonte, então você chama Validator por conta própria.
Desafio
MédioMova as regras do título para TaskInput e adicione uma nova: o título pode ter no máximo 80 caracteres.
- Você tem um novo arquivo,
Validation.cs. O métodoErrorstransforma os resultados no dicionário queResults.ValidationProblemrecebe. Onde o comentário indica, chameValidator.TryValidateObjectemmodelcom um novoValidationContext(model),resultsevalidateAllProperties: true. - No início de
Program.cs, adicioneusing System.ComponentModel.DataAnnotations;e atribua dois atributos aoTitledeTaskInput:[property: Required(ErrorMessage = "Title is required."), StringLength(80)]. - Em POST e PUT, substitua a verificação
IsNullOrWhiteSpaceporvar errors = Validation.Errors(input);e retorneResults.ValidationProblem(errors)quando não fornull.
Um título com 81 caracteres agora retorna 400 com:
"errors": { "title": ["The field Title must be a string with a maximum length of 80."] }Experimente: pressione Run e faça um POST de um corpo cujo título tenha 81 letras para /api/tasks: 400 e o erro acima. Faça um POST de { "title": "" }: 400 com Title is required., como antes. Faça um POST de { "title": "Order new chairs" }: 201.
Experimente você mesmo
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);