URL’s and Routes are defined in the
conf/routes file, and the basic syntax is three columns as example below:
[METHOD] [URL Pattern] [Controller.Action] GET / MySite.Welcome
# conf/routes # This file defines all application routes # Higher priority routes first module:jobs # Import all routes from the jobs module GET /login App.Login # A simple path GET /hotels/ Hotels.Index # Match /hotels and /hotels/ (optional trailing slash) GET /hotels/:id Hotels.Show # Extract a URI argument WS /hotels/:id/feed Hotels.Feed # WebSockets. POST /hotels/:id/:action Hotels.:action # Automatically route some actions. GET /public/*filepath Static.Serve("public") # Map /app/public resources under /public/... * /debug/ module:testrunner # Prefix all routes in the testrunner module with /debug/ * /:controller/:action :controller.:action # Catch all; Automatic URL generation
Let’s go through the lines one at a time. At the end, we’ll see how to accomplish reverse routing i.e generating the URL to invoke a particular action.
GET /login App.Login GET /about App.About
The routes above use an ‘exact match’ of HTTP method and path and invoke the Login and About action on the App controller.
GET /hotels/ Hotels.Index
Hotels.Indexwill include the trailing slash/
Trailing slashes should not be used to differentiate between actions. The
/login will be matched by a request to
GET /hotels/:id Hotels.Show
:idvariable above will match anything except a slash. For example,
/hotels/abcwould both be matched by the route above.
GET /public/*filepath Static.Serve("public")
The starred parameter must be the first element in the path, and match all remaining path elements.
For example, in the case above it will match any path beginning with
its value will be the path substring that follows the
As also demonstrated in Static Serving below, routes may specify one or more parameters to the action. For example:
GET /products/:id ShowList("PRODUCT") GET /menus/:id ShowList("MENU")
The provided argument(s) are bound to a parameter name using their position. In this case, the list type string would be bound to the name of the first action parameter.
This is helpful in situations where:
POST /hotels/:id/:action Hotels.:action * /:controller/:action :controller.:action
URL argument extraction can also be used to determine the invoked action. Matching to controllers and actions is case insensitive.
The first example route line would effect the following routes:
/hotels/1/show => Hotels.Show /hotels/2/details => Hotels.Details
Similarly, the second example may be used to access any action in the application:
/app/login => App.Login /users/list => Users.List
Since matching to controllers and actions is case insensitive, the following routes would also work:
/APP/LOGIN => App.Login /Users/List => Users.List
Using auto-routing as a catch-all (e.g. last route in the file) is useful for quickly hooking up actions to non-vanity URLs, especially in conjunction with the reverse router.
GET /public/*filepath Static.Serve("public") GET /favicon.ico Static.Serve("public","img/favicon.png") GET /img/icon.png Static.Serve("public", "img/icon.png") << space causes error
prefix(string) - A (relative or absolute) path to the asset root.
filepath(string) - A relative path that specifies the requested file.
Static.Serve, blank spaces are not allowed between
,due to how
Modules which contain routes can be imported into your application in two ways:
In the example below, its assumed
mymodule has a
routes file containing:
GET /gopher MyModule.FetchGopher POST /gopher/add MyModule.AddGopher
# mymodule routes module:mymodule # Other routes GET / Application.Index GET /bar Application.Bar
# mymodule routes with prefix - Must be defined with an asterisk * for the method * /myurl module:mymodule # Other routes GET / Application.MyAction GET /foo Application.FooAction
WS /hotels/:id/feed Hotels.Feed
Websockets are routed the same way as other requests with the ‘method’
It is good practice to use a reverse router to generate URL’s instead of hardcoding for a few reasons including:
Upon building your application, Revel generates an
app/routes package. Use it
with a statement of the form:
The above statement returns an URL string to
Controller.Action with the
Below is a more complete example: