Menu
CoddyTech

Suchen

Teil des Abschnitts REST-APIs der ASP.NET Core-Journey von Coddy. Lektion 11 von 20.

Eine Suche ist ein weiterer Filter in der Abfragezeichenfolge. Bei einer Bibliotheks-API liefert GET /api/books?search=potter die Bücher, deren Titel den Text enthalten. Filter werden gestapelt: Jeder schränkt die Ergebnisse weiter ein, die der vorherige übrig gelassen hat.

if (!string.IsNullOrWhiteSpace(search))
    result = result.Where(b =>
        b.Title.Contains(search, StringComparison.OrdinalIgnoreCase));

Contains vergleicht standardmäßig exakt, sodass Potter bei einer Suche nach potter nicht gefunden würde. StringComparison.OrdinalIgnoreCase ignoriert Groß- und Kleinschreibung. Überspringe den Filter, wenn die Suche null oder leer ist: ?search= sendet eine leere Zeichenfolge, und ein Client, der sein Suchfeld leert, erwartet die gesamte Liste zurück.

challenge icon

Aufgabe

Einfach

Lass Clients Aufgaben anhand eines Worts in ihrem Titel finden.

  1. Gib der Lambda-Funktion für GET /api/tasks einen zweiten Parameter, string? search.
  2. Behalte nach dem done-Filter die Aufgaben, deren Titel den Suchbegriff enthält, ohne die Groß- und Kleinschreibung zu beachten, wenn search weder null noch ein Leerzeichen ist.
  3. Behalte den done-Filter bei: Beide Filter funktionieren zusammen.

GET /api/tasks?search=ROOM findet Aufgabe 2, Book the meeting room. GET /api/tasks?search=the&done=false findet die Aufgaben 1 und 3: Jeder Titel enthält "the", und diese beiden sind noch offen.

Probiere es aus: Drücke „Ausführen“ und sende GET /api/tasks?search=ROOM: Aufgabe 2. Sende GET /api/tasks?search=in: die Aufgaben 2 und 3, wegen „meeting“ und „invoice“. Sende GET /api/tasks?search=: alle drei.

Probier es selbst

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) =>
{
    IEnumerable<TaskItem> result = tasks;
    if (done is not null) result = result.Where(t => t.Done == done);
    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);

Alle Lektionen in REST-APIs