Menu
CoddyTech

페이지 나누기

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

주문이 10,000개인 API는 한 번에 모두 응답할 수 없습니다. 페이지네이션은 일부 항목만 응답합니다. GET /api/orders?page=3&pageSize=20은 41번부터 60번까지의 주문입니다. 클라이언트에는 "500페이지 중 3페이지"를 표시하기 위한 전체 개수도 필요하며, 헤더를 사용하면 본문 형식을 변경하지 않고 이를 전달할 수 있습니다.

app.MapGet("/api/orders", (HttpResponse response, int page = 1, int pageSize = 20) =>
{
    var matching = orders.ToList();
    response.Headers["X-Total-Count"] = matching.Count.ToString();
    return Results.Ok(matching.Skip((page - 1) * pageSize).Take(pageSize));
});

기본값을 지정하면 쿼리 매개변수를 선택 사항으로 만들 수 있습니다. HttpResponse 매개변수는 작성 중인 응답이므로, 응답을 반환하기 전에 헤더를 설정할 수 있습니다. X-Total-Count는 페이지네이션을 적용하기 전에 필터와 일치하는 주문의 개수를 셉니다. 페이지 번호가 1보다 작으면 요청을 거부하고 페이지 크기에 상한을 두어, 어떤 클라이언트도 한 번에 모든 항목을 요청할 수 없도록 하세요.

challenge icon

챌린지

중급

작업을 한 페이지씩 응답하고, 전체 작업 수를 말하세요.

  1. GET /api/tasks 람다의 sort 뒤에 매개변수 세 개를 추가하세요: HttpResponse response, int page = 1, int pageSize = 10.
  2. 오류 딕셔너리에서 page가 1보다 작으면 page 아래에 Page starts at 1.을 추가하고, pageSize가 1~50 범위를 벗어나면 pageSize 아래에 Page size is 1 to 50.을 추가하세요.
  3. 필터링과 정렬을 마친 후 결과를 리스트로 변환하세요. 헤더 X-Total-Count에 결과의 개수를 설정한 다음, 해당 페이지의 항목만 응답하세요. 작업을 (page - 1) * pageSize개 건너뛰고 pageSize개를 가져오세요.

GET /api/tasks?page=2&pageSize=2는 작업 3만 응답하며, X-Total-Count: 3을 포함합니다. 마지막 페이지를 넘어선 페이지는 200과 []를 응답합니다.

직접 해보기: Run을 누르고 GET /api/tasks?page=2&pageSize=2를 보내세요. 작업 3이 응답되고 Headers 탭에 X-Total-Count: 3이 표시됩니다. GET /api/tasks?done=false&pageSize=1을 보내세요. 작업 1과 X-Total-Count: 2가 응답됩니다. GET /api/tasks?page=0&pageSize=99를 보내세요. 두 오류와 함께 400이 응답됩니다.

직접 해보기

using System.ComponentModel.DataAnnotations;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddProblemDetails();
var app = builder.Build();

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

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;

bool TitleTaken(string title, int exceptId) =>
    tasks.Any(t => t.Id != exceptId && string.Equals(t.Title, title, StringComparison.OrdinalIgnoreCase));

app.MapGet("/api/tasks", (bool? done, string? search, string? sort) =>
{
    var errors = new Dictionary<string, string[]>();
    if (sort is not null && sort != "id" && sort != "title")
        errors["sort"] = ["Sort by id or title."];
    if (errors.Count > 0) return Results.ValidationProblem(errors);

    IEnumerable<TaskItem> result = tasks;
    if (done is not null) result = result.Where(t => t.Done == done);
    if (!string.IsNullOrWhiteSpace(search))
        result = result.Where(t => t.Title.Contains(search, StringComparison.OrdinalIgnoreCase));
    if (sort == "title") result = result.OrderBy(t => t.Title);
    return Results.Ok(result);
});

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);
    if (TitleTaken(input.Title, 0))
        return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
    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();
    if (TitleTaken(input.Title, id))
        return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
    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();
    if (patch.Title is not null && TitleTaken(patch.Title, id))
        return Results.Problem(title: "A task with this title already exists.", statusCode: 409);
    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의 모든 레슨