検索
CoddyのASP.NET Coreジャーニー「REST API」セクションの一部。レッスン 11/20。
検索はクエリ文字列の別のフィルターです。ライブラリのAPIでは、GET /api/books?search=potterを使うと、タイトルにそのテキストを含む書籍が返されます。フィルターは重ねて適用され、それぞれが直前のフィルターで残った結果をさらに絞り込みます。
if (!string.IsNullOrWhiteSpace(search))
result = result.Where(b =>
b.Title.Contains(search, StringComparison.OrdinalIgnoreCase));Containsは既定では大文字と小文字を区別して比較するため、Potterはpotterでの検索に一致しません。StringComparison.OrdinalIgnoreCaseは大文字と小文字を区別しません。検索語がnullまたは空の場合はフィルターを適用しないでください。?search=は空文字列を送信するため、検索ボックスをクリアしたクライアントは一覧全体が返されることを期待します。
チャレンジ
簡単タイトル内の単語でタスクを検索できるようにします。
GET /api/tasksのラムダに、2つ目のパラメーターstring? searchを追加します。doneフィルターの後に、searchが null でも空白でもない場合、タイトルにその単語を含むタスクを大文字と小文字を区別せずに残します。doneフィルターも残します。2つのフィルターは併用できます。
GET /api/tasks?search=ROOM はタスク2の Book the meeting room を返します。GET /api/tasks?search=the&done=false はタスク1と3を返します。すべてのタイトルに "the" が含まれており、この2つは未完了です。
試してみましょう:「実行」を押して GET /api/tasks?search=ROOM を送信します。タスク2が返ります。GET /api/tasks?search=in を送信します。meeting と invoice に該当するタスク2と3が返ります。GET /api/tasks?search= を送信します。3つすべてが返ります。
自分で試してみよう
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);