Ordenação
Parte da seção APIs REST do Journey de ASP.NET Core da Coddy. Lição 12 de 20.
Um parâmetro sort permite que o cliente escolha a ordem: GET /api/products?sort=price. Aceite apenas as ordens que você oferece e responda com 400 para qualquer outra, para que um erro de digitação como sort=prise seja informado em vez de ignorado.
var errors = new Dictionary<string, string[]>();
if (sort is not null && sort != "name" && sort != "price")
errors["sort"] = ["Sort by name or price."];
if (errors.Count > 0) return Results.ValidationProblem(errors);
if (sort == "price") result = result.OrderBy(p => p.Price);OrderBy retorna uma nova sequência ordenada e não altera a lista. products.Sort(...) reordenaria a própria lista armazenada, então todas as respostas posteriores também viriam na nova ordem. Reunir os erros em um único dicionário permite que uma solicitação com vários problemas informe todos eles de uma só vez.
Desafio
FácilPermita que os clientes ordenem as tarefas pelo título.
- Adicione um terceiro parâmetro à lambda de
GET /api/tasks:string? sort. - No início da lambda, reúna os erros em um dicionário. Quando
sortnão fornull,idoutitle, adicioneSort by id or title.sobsorte responda comResults.ValidationProblem(errors)quando o dicionário tiver algum erro. - Depois dos filtros, quando
sortfortitle, ordene o resultado pelo título comOrderBy. Semsortou comsort=id, as tarefas permanecem na ordem dos IDs.
GET /api/tasks?sort=title responde com as tarefas 2, 3 e 1: Book, Send, Write.
Experimente: pressione Executar e envie GET /api/tasks?sort=title: a ordem acima. Envie GET /api/tasks: de volta à ordem dos IDs. Envie GET /api/tasks?sort=size: 400 com "errors": { "sort": ["Sort by id or title."] }. Envie GET /api/tasks?done=false&sort=title: tarefas 3 e 1.
Experimente você mesmo
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) =>
{
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));
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);