Atributos de validación
Parte de la sección API REST del Journey de ASP.NET Core de Coddy. Lección 7 de 20.
Escribir cada regla como un if se hace largo. Las anotaciones de datos colocan las reglas en el tipo como atributos, desde System.ComponentModel.DataAnnotations, y Validator comprueba un objeto frente a ellas.
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);En un registro posicional, property: coloca el atributo en la propiedad, que es donde lo busca Validator. Sin validateAllProperties: true, solo comprueba [Required]. Cada regla incumplida añade un ValidationResult con el nombre de la propiedad y un mensaje. .NET 10 también tiene builder.Services.AddValidation(), que comprueba los parámetros de los endpoints por ti, pero para tus propios tipos necesita un generador de código fuente. El ejecutor de aquí no ejecuta generadores de código fuente, así que tienes que llamar a Validator tú mismo.
Desafío
IntermedioMueve las reglas del título a TaskInput y añade una nueva: el título debe tener como máximo 80 caracteres.
- Tienes un nuevo archivo,
Validation.cs. Su métodoErrorsconvierte los resultados en el diccionario que recibeResults.ValidationProblem. Donde aparece el comentario, llama aValidator.TryValidateObjectenmodelcon un nuevoValidationContext(model),resultsyvalidateAllProperties: true. - Al principio de
Program.cs, añadeusing System.ComponentModel.DataAnnotations;y asigna aTitledeTaskInputdos atributos:[property: Required(ErrorMessage = "Title is required."), StringLength(80)]. - En POST y PUT, reemplaza la comprobación de
IsNullOrWhiteSpaceporvar errors = Validation.Errors(input);y devuelveResults.ValidationProblem(errors)cuando no seanull.
Un título de 81 caracteres ahora devuelve 400 con:
"errors": { "title": ["The field Title must be a string with a maximum length of 80."] }Pruébalo: pulsa Ejecutar y envía con POST un cuerpo cuyo título tenga 81 letras a /api/tasks: 400 y el error anterior. Envía con POST { "title": "" }: 400 con Title is required., como antes. Envía con POST { "title": "Order new chairs" }: 201.
Pruébalo tú mismo
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);
Todas las lecciones de API REST
2Validación y errores
Rechazar entradas no válidas5Navegadores y alojamiento
CORS