Menu
CoddyTech

Sortowanie

Część sekcji API REST ścieżki ASP.NET Core w Coddy. Lekcja 12 z 20.

Parametr sort pozwala klientowi wybrać kolejność: GET /api/products?sort=price. Akceptuj tylko obsługiwane kolejności, a w pozostałych przypadkach zwracaj kod 400, aby literówka, taka jak sort=prise, została zgłoszona zamiast zignorowana.

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 zwraca nową, posortowaną sekwencję i pozostawia listę bez zmian. products.Sort(...) zmieniłoby kolejność elementów na samej zapisanej liście, więc każda kolejna odpowiedź również byłaby zwracana w nowej kolejności. Zbieranie błędów w jednym słowniku pozwala poinformować o wszystkich naraz, gdy żądanie zawiera kilka błędów.

challenge icon

Wyzwanie

Łatwy

Pozwól klientom sortować zadania według tytułu.

  1. Dodaj trzeci parametr string? sort do lambdy GET /api/tasks.
  2. Na początku lambdy zbieraj błędy w słowniku. Gdy sort nie jest null, id ani title, dodaj Sort by id or title. pod kluczem sort i zwróć Results.ValidationProblem(errors), gdy słownik zawiera jakieś błędy.
  3. Po filtrach, gdy sort ma wartość title, uporządkuj wynik według tytułu za pomocą OrderBy. Bez parametru sort lub z sort=id zadania pozostają w kolejności według identyfikatora.

GET /api/tasks?sort=title zwraca zadania 2, 3 i 1: Book, Send, Write.

Wypróbuj: naciśnij Uruchom i wyślij GET /api/tasks?sort=title: otrzymasz powyższą kolejność. Wyślij GET /api/tasks: zadania wrócą do kolejności według identyfikatora. Wyślij GET /api/tasks?sort=size: otrzymasz 400 z "errors": { "sort": ["Sort by id or title."] }. Wyślij GET /api/tasks?done=false&sort=title: zadania 3 i 1.

Spróbuj swoich sił

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

Wszystkie lekcje w sekcji API REST