Routing

Masonite ships with a really powerful routing engine. Routing helps link a browser URL to its controller and controller action.
Creating a Route
Routes are created by importing the Route class and defining the HTTP verb you would like with the URL and the controller you would like to use. These routes need to be wrapped in a ROUTES list inside your routes file.
1
from masonite.routes import Route
2
​
3
ROUTES = [
4
	Route.get('/welcome', '[email protected]')  
5
]
Copied!
The first parameter is the URL you would like to be available in your application. In the above example, this will allow anybody to go to the /welcome URL.
Available Route Options
You may choose to define any one of the available verbs:
1
Route.get('/welcome', '[email protected]')
2
Route.post('/welcome', '[email protected]')
3
Route.put('/welcome', '[email protected]')
4
Route.patch('/welcome', '[email protected]')
5
Route.delete('/welcome', '[email protected]')
6
Route.options('/welcome', '[email protected]')
Copied!
In addition to these route verbs you can use built in routes:
1
Route.redirect('/old', '/new', status=301)
2
Route.permanent_redirect('/old', '/new')
Copied!
Route Options
Middleware
You may define several available methods on your routes to modify their behavior during the request.
The first option is to define middleware:
1
Route.get('/welcome', '[email protected]').middleware('web')
Copied!
This will attach the middleware key to the route which will be picked up from your middleware configuration later in the request.
Name
You can specify a name for your route. This is used to easily compile route information in other parts of your application by using the route name which is much more static than a URL.
1
Route.get('/welcome', '[email protected]').name('welcome')
Copied!
Parameters
You can specify the parameters in the URL that will later be able to be retrieved in other parts of your application. You can do this easily by specify the parameter name attached to a @ symbol:
1
Route.get('/dashboard/@user_id', '[email protected]').name('welcome')
Copied!
Domain
You can specify the subdomain you want this route to be matched to. If you only want this route to be matched on a "docs" subdomain (docs.example.com):
1
Route.get('/dashboard/@user_id', '[email protected]').domain('docs')
Copied!
Route Compilers
Route compilers are a way to match on a certain route parameter by a specific type. For example, if you only watch to match where the @user_id is an integer. You can do this by appending a : character and compiler name to the parameter:
1
Route.get('/dashboard/@user_id:string', '[email protected]').name('welcome')
Copied!
Available route compilers are:
integer
int (alias for integer)
string
signed
Route Groups
Route groups are a great way to group mulitple routes together that have similiar options like a prefix, or multiple routes with the same middleware.
A route uses the group() method that accepts a list of routes and keyword arguments for the options:
1
ROUTES = [
2
  Route.group([
3
    Route.get('/settings', '[email protected]').name('settings'),
4
    Route.get('/monitor', '[email protected]').name('monitor'),
5
  ], 
6
  prefix="/dashboard",
7
  middleware=['web', 'cors'],
8
  name="dashboard."),
9
  domain="docs"
10
]
Copied!
The prefix and name options will prefix the options set in the routes inside the group. In the above example, the names of the routes would dashboard.settings with a URL of /dashboard/settings and dashboard.monitor and a URL of /dashboard/monitor.

Prologue - Previous

How To Contribute

Next - The Basics

Controllers

Last modified 2mo ago

Export as PDF

Copy link

Contents

Creating a Route

Available Route Options