Постраничная навигация
Часть раздела REST API путешествия по ASP.NET Core на Coddy. Урок 13 из 20.
API заказов с 10 000 заказов не может выдать их все сразу. Разбиение на страницы позволяет получить одну часть: GET /api/orders?page=3&pageSize=20 — это заказы с 41-го по 60-й. Клиенту также нужно общее количество, чтобы показать «страница 3 из 500», и заголовок передаёт его, не меняя структуру тела ответа.
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 и ограничивайте размер страницы, чтобы ни один клиент не мог запросить всё сразу.
Задание
СреднеОтвечай на задачи по одной странице за раз и указывай их общее количество.
- Добавь три параметра в лямбда-выражение
GET /api/tasksпослеsort:HttpResponse response,int page = 1иint pageSize = 10. - В словаре ошибок добавь
Page starts at 1.дляpage, если значениеpageменьше 1, иPage size is 1 to 50.дляpageSize, если значениеpageSizeвыходит за диапазон от 1 до 50. - После фильтрации и сортировки преобразуй результат в список. Установи заголовок
X-Total-Countравным количеству элементов, а затем верни только нужную страницу: пропусти(page - 1) * pageSizeзадач и возьмиpageSize.
GET /api/tasks?page=2&pageSize=2 возвращает только задачу 3 с заголовком X-Total-Count: 3. Если запрошена страница за пределами списка, возвращается ответ 200 и [].
Попробуй: нажми «Запустить» и отправь GET /api/tasks?page=2&pageSize=2: задача 3; на вкладке заголовков отображается 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);
В этом уроке есть небольшой тест. Начните урок, чтобы ответить на вопросы и сохранить прогресс.