Menu
CoddyTech

Logging Every Request

Part of the Minimal APIs section of Coddy's ASP.NET Core journey. Lesson 17 of 20.

A middleware can watch what the app answers. app.Logger is a logger the app already has, for code outside endpoints. This one warns about requests that found nothing:

app.Use(async (context, next) =>
{
    await next();
    if (context.Response.StatusCode == 404)
        app.Logger.LogWarning("Nothing at {Path}", context.Request.Path);
});

It reads the status after await next(), on the way back, when an endpoint or a later middleware has set it; before next() the status is still 200. Where it sits matters too. The middleware added first meets every request, including the ones a later middleware ends early, and it is the last to run on the way out.

challenge icon

Challenge

Easy

The Console gets one line per request, such as GET /api/recipes/2 -> 200.

  1. In Program.cs, right after var app = builder.Build();, above the X-Api-Version middleware, add a middleware.
  2. It calls await next(); first, then app.Logger.LogInformation("{Method} {Path} -> {Status}", context.Request.Method, context.Request.Path, context.Response.StatusCode);.

Try it: press Run. The first request is GET /recipes/2, and the Console shows GET /recipes/2 -> 301. Send GET /api/recipes/99: the warning from the last lesson, then GET /api/recipes/99 -> 404. Send GET /index.html: GET /index.html -> 200.

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.Use(async (context, next) =>
{
    if (context.Request.Path.StartsWithSegments("/recipes"))
    {
        context.Response.Redirect("/api" + context.Request.Path + context.Request.QueryString, permanent: true);
        return;
    }
    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, ILogger<Program> logger) =>
{
    var recipe = recipes.FirstOrDefault(r => r.Id == id);
    if (recipe is null)
    {
        logger.LogWarning("Recipe {Id} was not found", id);
        return Results.NotFound(new { error = $"Recipe {id} not found" });
    }
    return Results.Ok(recipe);
});

app.MapPost("/api/recipes", (NewRecipe input, ILogger<Program> logger) =>
{
    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);
    logger.LogInformation("Added recipe {Id}: {Name}", recipe.Id, recipe.Name);
    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