Overview of registering new routes in nopCommerce

ASP.NET routing enables you to use URLs that do not have to map to specific files in a Web site. Because the URL does not have to map to a file, you can use URLs that are descriptive of the user's action and therefore are more easily understood by users.The ASP.NET MVC framework and ASP.NET Dynamic Data extend routing to provide features that are used only in MVC applications and in Dynamic Data applications. You can find more information here.

You can also look into this example that explains the ASP.NET routing. The ASP.NET Routing module is responsible for mapping incoming browser requests to particular MVC controller actions.

nopCommerce follows the IRouteProvider interface which is used for route registration during application start-up. All core routes are registered in the RouteProvider class located in the Nop.Web project.

In your project, open RouteProvider.cs - You will find this file in this location: Nop.Web/Infrastructure/RouteProvider.cs

using System.Web.Mvc;
using System.Web.Routing;
using Nop.Web.Framework.Localization;
using Nop.Web.Framework.Mvc.Routes;
namespace Nop.Web.Infrastructure
    public partial class RouteProvider : IRouteProvider
        public void RegisterRoutes(RouteCollection routes)
            //We reordered our routes so the most used ones are on top. It can improve performance.
            //home page
                            new { controller = "Home", action = "Index" },
                            new[] { "Nop.Web.Controllers" });

You can create different RouteProvider classes according to your requirements like:
- Creating a new page (see this article)
- Plugins using custom routes

Here are a few examples on how RouteProvider classes have been created for registering various routes.

            //we have this route for performance optimization because named routes are MUCH faster than usual Html.Action(...)
            //and this route is highly used
                            new { controller = "Widget", action = "WidgetsByZone" },
                            new[] { "Nop.Web.Controllers" });
                            new { controller = "Customer", action = "Login" },
                            new[] { "Nop.Web.Controllers" });
                            new { controller = "Customer", action = "Register" },
                            new[] { "Nop.Web.Controllers" });

Hope it helps!

About Author

Written By Lavish Kumar

Based out of New York, USA, Lavish Kumar is a full stack web developer by profession and founder of Striving Programmers, a trusted community for developers that offers a wealth of articles and forums to assist individuals with improving their software development skills.

Leave your comment