0Pricing
C# Academy · 강의

API에 유효성 검사 통합

깔끔한 유효성 검사 오류 응답을 반환합니다.

API에 유효성 검사 통합은(는) CoddyKit의 무료 C# Academy 강의입니다. 이것은 4개 중 4번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 C# Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. C# Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

ASP.NET Core에 FluentValidation 연결하기

요청을 자동으로 검증하려면 유효성 검사기를 의존성 주입에 등록합니다. AddValidatorsFromAssembly 도우미는 어셈블리를 검색하여 찾은 모든 유효성 검사기를 등록합니다.

using FluentValidation;

builder.Services
    .AddValidatorsFromAssemblyContaining<CustomerValidator>();

자동 유효성 검사 미들웨어

최신 FluentValidation은 명시적 유효성 검사를 선호하지만, 모델 바인딩에 연결되는 자동 유효성 검사를 활성화하여 작업 메서드가 실행되기 전에 잘못된 요청을 거부할 수 있습니다.

dotnet add package FluentValidation.AspNetCore

builder.Services.AddFluentValidationAutoValidation();

DI에서 해결되는 유효성 검사기

유효성 검사기는 DI에 등록되므로 리포지토리와 같은 서비스를 주입할 수 있습니다. 따라서 데이터베이스를 사용하는 비동기 규칙도 API에서 원활하게 동작합니다.

public class UserValidator : AbstractValidator<UserRequest>
{
    public UserValidator(IUserRepository repo)
    {
        RuleFor(u => u.Email)
            .MustAsync(async (e, ct) => !await repo.ExistsAsync(e));
    }
}

엔드포인트에서 명시적으로 유효성 검사하기

많은 팀은 명확성을 위해 명시적 유효성 검사를 선호합니다. IValidator<T>를 주입하고 handler의 시작 부분에서 호출합니다.

app.MapPost("/users", async (
    UserRequest request,
    IValidator<UserRequest> validator) =>
{
    var result = await validator.ValidateAsync(request);
    if (!result.IsValid)
        return Results.ValidationProblem(result.ToDictionary());
    return Results.Ok();
});

ProblemDetails란

ProblemDetails(RFC 7807)는 HTTP 오류 응답을 위한 표준 JSON 형식입니다. type, title, status, detail과 같은 필드를 제공하여 클라이언트가 일관된 오류 구조를 사용할 수 있게 합니다.

{
  "type": "https://tools.ietf.org/html/rfc7231",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": { "Email": ["Email is required."] }
}

ValidationProblemDetails

유효성 검사 실패에 대해 ASP.NET Core는 ValidationProblemDetails를 사용합니다. 이는 ProblemDetails를 확장하여 각 필드를 해당 메시지에 매핑하는 errors 사전을 추가합니다.

return Results.ValidationProblem(result.ToDictionary());
// Produces a 400 ValidationProblemDetails response

FluentValidation 결과 변환하기

ToDictionary() 확장은 ValidationResult를 ValidationProblem에서 요구하는 field -> messages 사전으로 변환합니다.

var result = await validator.ValidateAsync(request);
if (!result.IsValid)
{
    IDictionary<string, string[]> errors = result.ToDictionary();
    return Results.ValidationProblem(errors);
}

ProblemDetails 출력 사용자 지정하기

AddProblemDetails와 사용자 지정 도우미를 사용하여 모든 오류 응답을 보강할 수 있습니다. 예를 들어 디버깅을 위해 추적 ID를 추가할 수 있습니다.

builder.Services.AddProblemDetails(options =>
{
    options.CustomizeProblemDetails = ctx =>
        ctx.ProblemDetails.Extensions["traceId"] =
            ctx.HttpContext.TraceIdentifier;
});

MVC 컨트롤러의 유효성 검사

자동 유효성 검사가 활성화되어 있고 [ApiController]가 적용되면, 요청이 유효하지 않을 때 컨트롤러 작업도 자동으로 ValidationProblemDetails를 반환하므로 모든 엔드포인트에서 형식이 일관되게 유지됩니다.

[ApiController]
[Route("api/[controller]")]
public class UsersController : ControllerBase
{
    [HttpPost]
    public IActionResult Create(UserRequest request) => Ok();
}

최소 API를 위한 유효성 검사 필터

엔드포인트 필터를 사용해 명시적 유효성 검사를 중앙화하면 각 처리기를 깔끔하게 유지할 수 있습니다.

app.MapPost("/users", (UserRequest r) => Results.Ok())
   .AddEndpointFilter<ValidationFilter<UserRequest>>();

자동 검사와 명시적 검사의 선택

자동 유효성 검사는 편리하지만 유효성 검사 단계를 숨기고, 명시적 유효성 검사는 장황하지만 동작이 명확하며 테스트하기도 쉽습니다. 많은 팀은 두 방식의 장점을 모두 얻기 위해 명시적 유효성 검사와 공유 필터를 함께 사용합니다.

빠른 확인

API 유효성 검사 통합을 테스트합니다.

요약

유효성 검사를 통합하려면 AddValidatorsFromAssembly로 유효성 검사기를 등록하고, 필요에 따라 자동 유효성 검사를 활성화한 다음, Results.ValidationProblem(result.ToDictionary())를 통해 오류를 ValidationProblemDetails로 반환해야 합니다. DI를 사용하면 유효성 검사기가 비동기 규칙에 저장소를 사용할 수 있으며, ProblemDetails를 사용자 지정하거나 엔드포인트 필터를 사용해 처리기를 깔끔하게 유지할 수 있습니다.

자주 묻는 질문

“API에 유효성 검사 통합” 강의는 무료인가요?

네 — “API에 유효성 검사 통합” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 C# Academy 강의 전체를 잠금 해제할 수 있습니다. C# Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

“API에 유효성 검사 통합”에서 뭘 배우나요?

깔끔한 유효성 검사 오류 응답을 반환합니다. 브라우저에서 직접 실행하는 실습 코드로 C# Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.

C# Academy을(를) 시작하는 데 경험이 필요한가요?

사전 경험은 필요하지 않습니다. CoddyKit의 C# Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 4번째 강의입니다.

“API에 유효성 검사 통합” 강의는 얼마나 걸리나요?

대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.

이 C# Academy 강의에서 코드를 작성하고 실행할 수 있나요?

네. 모든 C# Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.

이 강의의 모든 강의

  1. 데이터 주석 유효성 검사
  2. FluentValidation 규칙
  3. 사용자 지정 및 조건부 규칙
  4. API에 유효성 검사 통합
← C# Academy(으)로 돌아가기