Menu
CoddyTech

문제 세부 정보

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

본문이 비어 있는 404 응답은 클라이언트가 무엇이 잘못되었는지 추측하게 만듭니다. 문제 세부 정보(RFC 9457)는 오류를 나타내는 표준 JSON 형식이며, application/problem+json 콘텐츠 유형으로 전송됩니다. 이미 400 응답에는 이 형식을 사용하고 있습니다. 주문 API에서는 세 줄만 추가하면 모든 오류가 같은 형식을 갖게 됩니다.

builder.Services.AddProblemDetails();
var app = builder.Build();

app.UseExceptionHandler();
app.UseStatusCodePages();

이제 주문이 없는 경우 GET /api/orders/7은 다음과 같은 404 응답을 반환합니다.

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "title": "Not Found", "status": 404,
  "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00" }

AddProblemDetails는 해당 형식의 응답을 작성하는 서비스를 등록합니다. UseStatusCodePages는 Results.NotFound()에서 반환되거나 경로에 해당하는 라우트가 없어 반환되는 등, 본문이 없는 모든 오류 응답에 문제 본문을 추가합니다. UseExceptionHandler는 처리되지 않은 예외를 500 문제 응답으로 바꿉니다. traceId는 요청마다 새로 생성되며, 응답을 서버 로그와 연결해 줍니다.

challenge icon

챌린지

쉬움

작업 추적기의 오류 응답을 하나의 형식으로 통일해, 클라이언트가 모든 실패를 같은 방식으로 읽게 하세요.

  1. Program.cs에서 builder.Build() 바로 앞 줄에 builder.Services.AddProblemDetails();를 추가하세요.
  2. builder.Build() 바로 뒤에 엔드포인트보다 앞서 app.UseExceptionHandler();를 추가한 다음 app.UseStatusCodePages();를 추가하세요.

다른 것은 변경하지 마세요. 엔드포인트는 계속 Results.NotFound()를 반환하고, 미들웨어가 응답 본문을 채웁니다. 그러면 GET /api/tasks/99는 콘텐츠 유형 application/problem+json으로 404와 다음 내용을 반환합니다.

{ "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5", "title": "Not Found", "status": 404, "traceId": "..." }

직접 해 보기: 실행을 누르고 GET /api/tasks/99를 보내세요. 위와 같은 404가 반환됩니다. 경로가 등록된 경로와 일치하지 않는 GET /api/projects를 보내세요. 같은 형식으로 반환됩니다. /api/tasks에 POST { "title": "" }를 보내세요. 400 응답에는 errors가 그대로 유지되고 traceId가 추가됩니다.

직접 해보기

using System.ComponentModel.DataAnnotations;

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) =>
{
    var errors = Validation.Errors(input);
    if (errors is not null) return Results.ValidationProblem(errors);
    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) =>
{
    var errors = Validation.Errors(input);
    if (errors is not null) return Results.ValidationProblem(errors);
    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(
    [property: Required(ErrorMessage = "Title is required."), StringLength(80)] string Title,
    bool Done);
record TaskPatch(string? Title, bool? Done);
quiz icon실력 점검

이 레슨에는 짧은 퀴즈가 포함되어 있습니다. 레슨을 시작해 문제를 풀고 진행 상황을 기록하세요.

REST API의 모든 레슨