RouteBuilder Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Routing

Assembly:: Microsoft.AspNetCore.Routing.dll

Package:: Microsoft.AspNetCore.Routing v1.0.0

Package:: Microsoft.AspNetCore.Routing v1.1.0

Package:: Microsoft.AspNetCore.Routing v2.0.0

Package:: Microsoft.AspNetCore.Routing v2.1.0

Package:: Microsoft.AspNetCore.Routing v2.2.0

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Package:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Source:: RouteBuilder.cs

Source:: RouteBuilder.cs

Source:: RouteBuilder.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides support for specifying routes in an application.

public ref class RouteBuilder : Microsoft::AspNetCore::Routing::IRouteBuilder

public class RouteBuilder : Microsoft.AspNetCore.Routing.IRouteBuilder

type RouteBuilder = class
    interface IRouteBuilder

Public Class RouteBuilder
Implements IRouteBuilder

Inheritance: Object
RouteBuilder

Implements: IRouteBuilder

Constructors

RouteBuilder(IApplicationBuilder, IRouter)	Constructs a new RouteBuilder instance given an `applicationBuilder` and `defaultHandler`.
RouteBuilder(IApplicationBuilder)	Constructs a new RouteBuilder instance given an `applicationBuilder`.

Properties

ApplicationBuilder	Gets the IApplicationBuilder.
DefaultHandler	Gets or sets the default IRouter that is used as a handler if an IRouter is added to the list of routes but does not specify its own.
Routes	Gets the routes configured in the builder.
ServiceProvider	Gets the sets the IServiceProvider used to resolve services for routes.

Methods

Build()

Builds an IRouter that routes the routes specified in the Routes property.

Extension Methods

MapRoute(IRouteBuilder, String, String, Object, Object, Object)	Adds a route to the IRouteBuilder with the specified name, template, default values, and data tokens.
MapRoute(IRouteBuilder, String, String, Object, Object)	Adds a route to the IRouteBuilder with the specified name, template, default values, and constraints.
MapRoute(IRouteBuilder, String, String, Object)	Adds a route to the IRouteBuilder with the specified name, template, and default values.
MapRoute(IRouteBuilder, String, String)	Adds a route to the IRouteBuilder with the specified name and template.
MapAreaRoute(IRouteBuilder, String, String, String, Object, Object, Object)	Adds a route to the IRouteBuilder with the given MVC area with the specified `name`, `areaName`, `template`, `defaults`, `constraints`, and `dataTokens`.
MapAreaRoute(IRouteBuilder, String, String, String, Object, Object)	Adds a route to the IRouteBuilder with the given MVC area with the specified `name`, `areaName`, `template`, `defaults`, and `constraints`.
MapAreaRoute(IRouteBuilder, String, String, String, Object)	Adds a route to the IRouteBuilder with the given MVC area with the specified `name`, `areaName`, `template`, and `defaults`.
MapAreaRoute(IRouteBuilder, String, String, String)	Adds a route to the IRouteBuilder with the given MVC area with the specified `name`, `areaName` and `template`.
MapSpaFallbackRoute(IRouteBuilder, String, Object, Object, Object)	Configures a route that is automatically bypassed if the requested URL appears to be for a static file (e.g., if it has a filename extension).
MapSpaFallbackRoute(IRouteBuilder, String, String, Object, Object, Object)	Configures a route that is automatically bypassed if the requested URL appears to be for a static file (e.g., if it has a filename extension).
MapWebApiRoute(IRouteBuilder, String, String, Object, Object, Object)
MapWebApiRoute(IRouteBuilder, String, String, Object, Object)
MapWebApiRoute(IRouteBuilder, String, String, Object)
MapWebApiRoute(IRouteBuilder, String, String)
MapDelete(IRouteBuilder, String, RequestDelegate)	Adds a route to the IRouteBuilder that only matches HTTP DELETE requests for the given `template`, and `handler`.
MapDelete(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP DELETE requests for the given `template`, and `action`.
MapDelete(IRouteBuilder, String, Func<HttpRequest,HttpResponse,RouteData,Task>)	Adds a route to the IRouteBuilder that only matches HTTP DELETE requests for the given `template`, and `handler`.
MapGet(IRouteBuilder, String, RequestDelegate)	Adds a route to the IRouteBuilder that only matches HTTP GET requests for the given `template`, and `handler`.
MapGet(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP GET requests for the given `template`, and `action`.
MapGet(IRouteBuilder, String, Func<HttpRequest,HttpResponse,RouteData,Task>)	Adds a route to the IRouteBuilder that only matches HTTP GET requests for the given `template`, and `handler`.
MapMiddlewareDelete(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP DELETE requests for the given `template`, and `action`.
MapMiddlewareGet(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP GET requests for the given `template`, and `action`.
MapMiddlewarePost(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP POST requests for the given `template`, and `action`.
MapMiddlewarePut(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP PUT requests for the given `template`, and `action`.
MapMiddlewareRoute(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder for the given `template`, and `action`.
MapMiddlewareVerb(IRouteBuilder, String, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP requests for the given `verb`, `template`, and `action`.
MapPost(IRouteBuilder, String, RequestDelegate)	Adds a route to the IRouteBuilder that only matches HTTP POST requests for the given `template`, and `handler`.
MapPost(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP POST requests for the given `template`, and `action`.
MapPost(IRouteBuilder, String, Func<HttpRequest,HttpResponse,RouteData,Task>)	Adds a route to the IRouteBuilder that only matches HTTP POST requests for the given `template`, and `handler`.
MapPut(IRouteBuilder, String, RequestDelegate)	Adds a route to the IRouteBuilder that only matches HTTP PUT requests for the given `template`, and `handler`.
MapPut(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP PUT requests for the given `template`, and `action`.
MapPut(IRouteBuilder, String, Func<HttpRequest,HttpResponse,RouteData,Task>)	Adds a route to the IRouteBuilder that only matches HTTP PUT requests for the given `template`, and `handler`.
MapRoute(IRouteBuilder, String, RequestDelegate)	Adds a route to the IRouteBuilder for the given `template`, and `handler`.
MapRoute(IRouteBuilder, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder for the given `template`, and `action`.
MapVerb(IRouteBuilder, String, String, RequestDelegate)	Adds a route to the IRouteBuilder that only matches HTTP requests for the given `verb`, `template`, and `handler`.
MapVerb(IRouteBuilder, String, String, Action<IApplicationBuilder>)	Adds a route to the IRouteBuilder that only matches HTTP requests for the given `verb`, `template`, and `action`.
MapVerb(IRouteBuilder, String, String, Func<HttpRequest,HttpResponse,RouteData,Task>)	Adds a route to the IRouteBuilder that only matches HTTP requests for the given `verb`, `template`, and `handler`.

Applies to

Share via