Menu
CoddyTech

Ordinamento

Fa parte della sezione API REST del percorso ASP.NET Core di Coddy. Lezione 12 di 20.

Un parametro sort consente al client di scegliere l’ordinamento: GET /api/products?sort=price. Accetta solo gli ordinamenti supportati e rispondi con 400 per qualsiasi altro valore, così un errore di battitura come sort=prise viene segnalato invece di essere ignorato.

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 restituisce una nuova sequenza ordinata e lascia invariato l’elenco. products.Sort(...) riordinerebbe l’elenco memorizzato stesso, quindi anche tutte le risposte successive arriverebbero nel nuovo ordine. Raccogliere gli errori in un unico dizionario consente a una richiesta con più errori di segnalarli tutti in una volta.

challenge icon

Sfida

Facile

Consenti ai client di ordinare le attività per titolo.

  1. Aggiungi un terzo parametro alla lambda GET /api/tasks: string? sort.
  2. All’inizio della lambda, raccogli gli errori in un dizionario. Quando sort non è null, id o title, aggiungi Sort by id or title. sotto sort e restituisci Results.ValidationProblem(errors) se il dizionario contiene errori.
  3. Dopo i filtri, quando sort è title, ordina il risultato per titolo con OrderBy. Senza sort, o con sort=id, le attività restano nell’ordine degli ID.

GET /api/tasks?sort=title restituisce le attività 2, 3 e 1: Book, Send, Write.

Prova: premi Esegui e invia GET /api/tasks?sort=title: l’ordine mostrato sopra. Invia GET /api/tasks: di nuovo nell’ordine degli ID. Invia GET /api/tasks?sort=size: 400 con "errors": { "sort": ["Sort by id or title."] }. Invia GET /api/tasks?done=false&sort=title: le attività 3 e 1.

Provalo tu

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);

Tutte le lezioni di API REST