Ending a Request Early
Part of the Minimal APIs section of Coddy's ASP.NET Core journey. Lesson 14 of 20.
A middleware that does not call next() ends the request there and answers it itself: the middleware below it, the static files and the endpoints never run.
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") is true for /admin and /admin/users, not for /administrator. To send the client to another address, context.Response.Redirect(url, permanent: true) answers 301 Moved Permanently with the address in the Location header, and a browser then requests it. Without permanent: true, it answers 302 Found, a move for now.
Challenge
EasyThe API used to live at /recipes, without /api. Old links lead to the new addresses.
- In
Program.cs, below theX-Api-Versionmiddleware and aboveapp.UseStaticFiles();, add anotherapp.Usemiddleware. - When
context.Request.Path.StartsWithSegments("/recipes"), callcontext.Response.Redirect("/api" + context.Request.Path + context.Request.QueryString, permanent: true);andreturnwithout callingnext(). - Otherwise,
await next();.
Try it: press Run. The first request is GET /recipes/2: status 301, and the Headers tab shows Location: /api/recipes/2 and X-Api-Version: 1. Send GET /recipes?category=soup: Location: /api/recipes?category=soup. Send GET /api/recipes/2: 200, not redirected.
Try it yourself
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();
All lessons in Minimal APIs
4Middleware and Logging
Your First Middleware2Results and JSON Bodies
Ok and Not Found