OKとNot Found
CoddyのASP.NET Coreジャーニー「Minimal API」セクションの一部。レッスン 6/20。
複数の方法で応答できるエンドポイントは、ステータスコードを設定する Results から結果を返します。Results.Ok(value) は値を JSON として返す 200 で、Results.NotFound() は 404 Not Found、存在しないものを示すコードです。
app.MapGet("/books/{id:int}", (int id) =>
{
var book = books.FirstOrDefault(b => b.Id == id);
if (book is null)
return Results.NotFound(new { error = "No such book" });
return Results.Ok(book);
});すべての return は Results を経由するため、同じ型である IResult を共有し、ラムダ式をコンパイルできます。new { error = "No such book" } は匿名オブジェクトです。ASP.NET Core はこれを {"error":"No such book"} として書き出します。これは何が問題だったのかをクライアントに伝える本文です。
チャレンジ
簡単GET /api/recipes/99 は null を返し、ステータスは 200 です。クライアントはそれを存在するレシピと区別できないため、404 を返すべきです。
Program.csで、GET /api/recipes/{id:int}のラムダ式に{ ... }のブロック本体を追加し、FirstOrDefaultでレシピを検索します。nullの場合は、Results.NotFound(new { error = $"Recipe {id} not found" })を返します。id が 99 の場合、本文は{"error":"Recipe 99 not found"}になります。- それ以外の場合は、
Results.Ok(recipe)を返します。
試してみましょう:「実行」を押します。GET /api/recipes/99 はステータス 404 と {"error":"Recipe 99 not found"} を返します。GET /api/recipes/2 を送信すると、これまでと同様にステータス 200 で Pancakes のレシピが返されます。
自分で試してみよう
var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();
var recipes = new List<Recipe>
{
new(1, "Tomato Soup", "soup", 25),
new(2, "Pancakes", "breakfast", 15),
new(3, "Lentil Soup", "soup", 40),
};
app.MapGet("/", () => "Recipe API is running");
app.MapGet("/api/recipes", (string? category) =>
recipes.Where(r => category is null || r.Category == category));
app.MapGet("/api/recipes/{id:int}", (int id) => recipes.FirstOrDefault(r => r.Id == id));
app.Run();