Doğrulama Nitelikleri
Coddy'nin ASP.NET Core Journey'sinin REST API'leri bölümünün bir parçası. Ders 7 / 20.
Her kuralı bir if olarak yazmak uzar. Veri ek açıklamaları, kuralları türün üzerine öznitelikler olarak ekler; bunlar System.ComponentModel.DataAnnotations ad alanındandır ve Validator bir nesneyi bu kurallara göre denetler.
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);Konumsal bir kayıtta property:, özniteliği özelliğe ekler; Validator da burada arama yapar. validateAllProperties: true olmadan yalnızca [Required] denetlenir. Her ihlal edilen kural, özelliğin adını ve bir iletiyi içeren bir ValidationResult ekler. .NET 10'da sizin için uç nokta parametrelerini denetleyen builder.Services.AddValidation() da bulunur; ancak kendi türleriniz için bir kaynak oluşturucu gerekir. Buradaki çalıştırıcı kaynak oluşturucuları çalıştırmadığından Validator öğesini kendiniz çağırırsınız.
Görev
OrtaBaşlık kurallarını TaskInput üzerine taşı ve yeni bir kural ekle: başlık en fazla 80 karakter olabilir.
- Yeni bir dosyan var:
Validation.cs. Bu dosyanınErrorsyöntemi sonuçları,Results.ValidationProblemyönteminin aldığı sözlüğe dönüştürür. Yorumun bulunduğu yeremodelüzerindeValidator.TryValidateObjectyöntemini, yeni birValidationContext(model),resultsvevalidateAllProperties: trueile çağır. Program.csdosyasının en üstüneusing System.ComponentModel.DataAnnotations;ekle veTaskInputiçindekiTitleözelliğine iki öznitelik ver:[property: Required(ErrorMessage = "Title is required."), StringLength(80)].- POST ve PUT işlemlerinde
IsNullOrWhiteSpacedenetiminivar errors = Validation.Errors(input);ile değiştir ve değernulldeğilseResults.ValidationProblem(errors)yanıtını döndür.
Artık 81 karakterlik bir başlık, şu yanıtla birlikte 400 döndürür:
"errors": { "title": ["The field Title must be a string with a maximum length of 80."] }Deneyin: Çalıştır'a bas ve /api/tasks adresine, başlığı 81 harften oluşan bir gövdeyle POST isteği gönder: 400 ve yukarıdaki hata. { "title": "" } ile POST gönder: Daha önce olduğu gibi Title is required. hatasıyla 400. { "title": "Order new chairs" } ile POST gönder: 201.
Kendin dene
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);