×
johrling

Get Registered Routes From An ASP.NET MVC Core Application

Written by Khalid Abuhakmeh
2
This post is days old.

I will start this post off by saying this may not be the best way to get the routes from your ASP.NET Core MVC web application. I am hoping there is a better way, but my current knowledge has led me to this answer. Given you have registered your routes, regardless of method, you should have a RouteCollection buried somewhere deep in your running application instance.

The RouteCollection is a member of the RouterMiddleware that ASP.NET Core uses to determine whether the current request is a match. For good reason, the member is private and passed to you via RouteData.

// from RouterMiddleware.Invoke
RouteContext context = new RouteContext(httpContext);
context.RouteData.Routers.Add(this._router);

Understanding what is happening inside of the RouterMiddleware, we should be able to access the router from our MVC Controller. We want the first router that is of type RouteCollection.

var routes = RouteData
                .Routers
                .OfType<RouteCollection>()
                .FirstOrDefault();

The final step is to display the output in your view.

asp.net core routes

Hope this post helps you debug your routing issues in ASP.NET Core.

Khalid Abuhakmeh
Khalid Abuhakmeh
Director of Software Development (Former)
ASP.NET Core
Routes
MVC
Suggested reading

Avoiding ASP.Net Core Configuration Pitfalls With Array Values

ASP.NET Core
ASP.NET Core continues to improve on the legacy of the .NET Framework. Our te...
Read now

Augmenting IPrincipal when using IdentityServer authentication middleware in ASP.NET Core

ASP.NET Core
This post covers augmenting an authenticated User for use in middleware or wh...
Read now

Getting route data in your ASP.NET Core middleware

ASP.NET Core
Requirement ASP.NET Core 2.2 or 3.0 Why can’t I do this in earlier vers...
Read now

Middleware Madness: Site Maintenance In ASP.NET Core

ASP.NET Core
Ideally, we would never have to take our site offline to do maintenance. All ...
Read now

RIMdev Sweeps The ASP.NET Monsters #SummerOfConfig Contest

ASP.NET Core
On July 18th, 2016 the ASP.NET Monsters announced a Summer Of Config contest....
Read now

Speech Recognition Configuration Provider For ASP.NET Core

ASP.NET Core
The ASP.NET Monsters recently announced a competition to create configuration...
Read now

Comments

Stay fresh! The brighter green, the fresher the article!