Menu
CoddyTech

Searching

Part of the REST APIs section of Coddy's ASP.NET Core journey. Lesson 11 of 20.

A search is another filter in the query string. In a library API, GET /api/books?search=potter answers the books whose title contains the text. Filters stack: each one narrows what the one before it left.

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

Contains compares exactly by default, so Potter would miss a search for potter. StringComparison.OrdinalIgnoreCase ignores capitals. Skip the filter when the search is null or empty: ?search= sends an empty string, and a client that clears its search box expects the whole list back.

challenge icon

Challenge

Easy

Let clients find tasks by a word in their title.

  1. Give the GET /api/tasks lambda a second parameter, string? search.
  2. After the done filter, when search is not null or white space, keep the tasks whose title contains it, ignoring case.
  3. Keep the done filter: the two work together.

GET /api/tasks?search=ROOM answers task 2, Book the meeting room. GET /api/tasks?search=the&done=false answers tasks 1 and 3: every title has "the", and those two are open.

Try it: press Run and send GET /api/tasks?search=ROOM: task 2. Send GET /api/tasks?search=in: tasks 2 and 3, for meeting and invoice. Send GET /api/tasks?search=: all three.

Try it yourself

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

All lessons in REST APIs