Menu
CoddyTech

Recherche

Fait partie de la section APIs REST du Journey ASP.NET Core de Coddy. Leçon 11 sur 20.

Une recherche est un autre filtre dans la chaîne de requête. Dans une API de bibliothèque, GET /api/books?search=potter renvoie les livres dont le titre contient le texte recherché. Les filtres s'empilent : chacun réduit les résultats laissés par le précédent.

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

Par défaut, Contains effectue une comparaison exacte : Potter ne serait donc pas trouvé lors d'une recherche de potter. StringComparison.OrdinalIgnoreCase ignore les majuscules. Ignore le filtre si la recherche est null ou vide : ?search= envoie une chaîne vide, et un client qui vide son champ de recherche s'attend à retrouver la liste complète.

challenge icon

Défi

Facile

Permets aux clients de trouver des tâches à partir d’un mot de leur titre.

  1. Ajoute un deuxième paramètre à la lambda GET /api/tasks : string? search.
  2. Après le filtre done, lorsque search n’est ni null ni composé d’espaces blancs, conserve les tâches dont le titre le contient, sans tenir compte de la casse.
  3. Conserve le filtre done : les deux fonctionnent ensemble.

GET /api/tasks?search=ROOM renvoie la tâche 2, Book the meeting room. GET /api/tasks?search=the&done=false renvoie les tâches 1 et 3 : chaque titre contient "the", et ces deux tâches ne sont pas terminées.

Essaie : appuie sur « Exécuter » et envoie GET /api/tasks?search=ROOM : tâche 2. Envoie GET /api/tasks?search=in : tâches 2 et 3, pour « meeting » et « invoice ». Envoie GET /api/tasks?search= : les trois tâches.

Essayez vous-même

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

Toutes les leçons de APIs REST