Menu
CoddyTech

검증 특성

Coddy ASP.NET Core 여정의 REST API 섹션에 포함된 레슨. 20개 중 7번째.

모든 규칙을 if로 작성하면 코드가 길어집니다. System.ComponentModel.DataAnnotations의 데이터 주석을 사용하면 특성으로 형식에 규칙을 지정할 수 있으며, Validator는 해당 규칙에 따라 객체를 검사합니다.

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

위치 지정 레코드에서는 property:를 사용해 특성을 속성에 지정합니다. Validator는 속성을 검사합니다. validateAllProperties: true가 없으면 [Required]만 검사합니다. 위반한 규칙마다 속성 이름과 메시지가 포함된 ValidationResult가 추가됩니다. .NET 10에는 엔드포인트 매개변수를 대신 검사해 주는 builder.Services.AddValidation()도 있지만, 사용자 정의 형식에 사용하려면 소스 생성기가 필요합니다. 여기의 실행 환경은 소스 생성기를 실행하지 않으므로 직접 Validator를 호출합니다.

challenge icon

챌린지

중급

제목 규칙을 TaskInput으로 옮기고 새 규칙을 추가하세요. 제목은 최대 80자입니다.

  1. 새 파일 Validation.cs가 있습니다. 이 파일의 Errors 메서드는 결과를 Results.ValidationProblem이 받는 딕셔너리로 변환합니다. 주석이 있는 곳에서 새 ValidationContext(model), results 및 validateAllProperties: true를 사용해 model에 Validator.TryValidateObject를 호출하세요.
  2. Program.cs 맨 위에 using System.ComponentModel.DataAnnotations;를 추가하고, TaskInput의 Title에 두 가지 특성을 지정하세요. [property: Required(ErrorMessage = "Title is required."), StringLength(80)]
  3. POST와 PUT에서 IsNullOrWhiteSpace 검사를 var errors = Validation.Errors(input);로 바꾸고, null이 아니면 Results.ValidationProblem(errors)을 반환하세요.

이제 81자 제목은 다음과 함께 400을 반환합니다.

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

직접 해보기: Run을 누르고 제목이 81자인 본문을 /api/tasks에 POST하세요. 400과 위 오류가 표시됩니다. { "title": "" }를 POST하면 이전과 같이 Title is required.와 함께 400이 표시됩니다. { "title": "Order new chairs" }를 POST하면 201이 표시됩니다.

직접 해보기

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

REST API의 모든 레슨