Modify response using middleware in ASP.NET Core 3

Question

My goal is to write a middleware that will take care of logging requests to my API and API's responses to those requests in a DB. I already made a middleware that handles exceptions in a similar fashion, but I got stumped over this. When you read MSDN about Middleware you can see this nice picture:

This makes you think that Middleware 2 receives the requests, does certain manipulations with it and passes it onto Middleware 3, then once all processing is done by middleware 3 it passes controls back to Middleware 2 for additional processing.

The only thing I do not understand is how to log the response if Middleware 2 Invoke() method is only called once during the request and not called during the response?

Startup.cs:

app.UseMiddleware<RequestLoggingMiddleware>();

Middleware:

 public class RequestLoggingMiddleware
    {
        private readonly RequestDelegate nextMiddleware;

        public RequestLoggingMiddleware(RequestDelegate nextMiddleware)
        {
            this.nextMiddleware = nextMiddleware;
            this.options = options;
        }

        public async Task Invoke(HttpContext context)
        {
            System.Diagnostics.Debug.WriteLine("Middleware runs");
            await nextMiddleware(context);
        }
    }
}

In the example above I only see "Middleware runs" once in a console, during the initial request but before the response is made. How do I get it to run during the response cycle?

Matt Hensley · Accepted Answer · 2020-04-20 17:58:30Z

7

To get the response, all you need to do is apply your same logic after the await nextMiddleware(context); line.

For example, to log the status code:

public class RequestLoggingMiddleware
{
    private readonly RequestDelegate nextMiddleware;

    public RequestLoggingMiddleware(RequestDelegate nextMiddleware)
    {
        this.nextMiddleware = nextMiddleware;
    }

    public async Task Invoke(HttpContext context)
    {
        System.Diagnostics.Debug.WriteLine("Middleware runs");
        await nextMiddleware(context);
        System.Diagnostics.Debug.WriteLine($"Response Code: {context.Response.StatusCode}");
    }
}

answered Apr 20, 2020 at 17:58

Matt Hensley

8939 silver badges18 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Novkovski Stevo Bato Over a year ago

How do you add a response header based on the request logic? I tried your code but "context.Response.Headers.Add("X-Test", "test");" does not work.

Collectives™ on Stack Overflow

Modify response using middleware in ASP.NET Core 3

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related