Menu
CoddyTech

リクエストを早期に終了する

CoddyのASP.NET Coreジャーニー「Minimal API」セクションの一部。レッスン 14/20。

next() を呼び出さないミドルウェアはそこでリクエストを終了し、自身で応答します。その下にあるミドルウェア、静的ファイル、エンドポイントは実行されません。

app.Use(async (context, next) =>
{
    if (context.Request.Path.StartsWithSegments("/admin"))
    {
        context.Response.StatusCode = 403;
        await context.Response.WriteAsync("Forbidden");
        return;
    }
    await next();
});

StartsWithSegments("/admin") は /admin と /admin/users では true になり、/administrator では true になりません。クライアントを別のアドレスに移動させるには、context.Response.Redirect(url, permanent: true) を使うと、Location ヘッダーにそのアドレスを含む 301 Moved Permanently が応答され、ブラウザーはそのアドレスにリクエストを送ります。permanent: true を指定しない場合は、ひとまず移動することを示す 302 Found が応答されます。

challenge icon

チャレンジ

簡単

APIは以前、/apiなしで/recipesにありました。古いリンクは新しいアドレスに転送されます。

  1. Program.csで、X-Api-Versionミドルウェアの下、app.UseStaticFiles();の上に、別のapp.Useミドルウェアを追加します。
  2. context.Request.Path.StartsWithSegments("/recipes")の場合、context.Response.Redirect("/api" + context.Request.Path + context.Request.QueryString, permanent: true);を呼び出し、next()を呼び出さずにreturnします。
  3. それ以外の場合は、await next();を実行します。

試してみましょう:「実行」を押します。最初のリクエストはGET /recipes/2です。ステータスは301で、「ヘッダー」タブにはLocation: /api/recipes/2とX-Api-Version: 1が表示されます。GET /recipes?category=soupを送信します。Location: /api/recipes?category=soupとなります。GET /api/recipes/2を送信します。ステータスは200で、リダイレクトされません。

自分で試してみよう

using Microsoft.AspNetCore.Http.HttpResults;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.Use(async (context, next) =>
{
    context.Response.Headers["X-Api-Version"] = "1";
    await next();
});

app.UseStaticFiles();

var recipes = new List<Recipe>
{
    new(1, "Tomato Soup", "soup", 25),
    new(2, "Pancakes", "breakfast", 15),
    new(3, "Lentil Soup", "soup", 40),
};
var nextId = 4;
var favoriteIds = new List<int>();

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) =>
{
    var recipe = recipes.FirstOrDefault(r => r.Id == id);
    if (recipe is null)
        return Results.NotFound(new { error = $"Recipe {id} not found" });
    return Results.Ok(recipe);
});

app.MapPost("/api/recipes", (NewRecipe input) =>
{
    if (string.IsNullOrWhiteSpace(input.Name))
        return Results.BadRequest(new { error = "Name is required" });
    if (input.Minutes <= 0)
        return Results.BadRequest(new { error = "Minutes must be more than 0" });
    var recipe = new Recipe(nextId++, input.Name, input.Category, input.Minutes);
    recipes.Add(recipe);
    return Results.Created($"/api/recipes/{recipe.Id}", recipe);
});

app.MapPut("/api/recipes/{id:int}", (int id, NewRecipe input) =>
{
    var index = recipes.FindIndex(r => r.Id == id);
    if (index == -1)
        return Results.NotFound(new { error = $"Recipe {id} not found" });
    var recipe = new Recipe(id, input.Name, input.Category, input.Minutes);
    recipes[index] = recipe;
    return Results.Ok(recipe);
});

app.MapDelete("/api/recipes/{id:int}", Results<NoContent, NotFound> (int id) =>
{
    var removed = recipes.RemoveAll(r => r.Id == id);
    return removed > 0 ? TypedResults.NoContent() : TypedResults.NotFound();
});

var favorites = app.MapGroup("/api/favorites");
favorites.MapGet("/", () => recipes.Where(r => favoriteIds.Contains(r.Id)));
favorites.MapPost("/{id:int}", (int id) =>
{
    if (!recipes.Any(r => r.Id == id))
        return Results.NotFound(new { error = $"Recipe {id} not found" });
    if (!favoriteIds.Contains(id))
        favoriteIds.Add(id);
    return Results.NoContent();
});
favorites.MapDelete("/{id:int}", (int id) =>
{
    favoriteIds.Remove(id);
    return Results.NoContent();
});

app.Run();

Minimal APIのすべてのレッスン