How to Visualize And Debug Routes
Warning: You are browsing the documentation for Symfony 3.x, which is no longer maintained.
Read the updated version of this page for Symfony 7.1 (the current stable version).
While adding and customizing routes, it's helpful to be able to visualize
and get detailed information about your routes. A great way to see every
route in your application is via the debug:router console command, which,
by default, lists all the configured routes in your application:
1 2 3 4 5 6 7 8 9 10 11 12
$ php bin/console debug:router
------------------ -------- -------- ------ ----------------------------------------------
Name Method Scheme Host Path
------------------ -------- -------- ------ ----------------------------------------------
homepage ANY ANY ANY /
contact GET ANY ANY /contact
contact_process POST ANY ANY /contact
article_show ANY ANY ANY /articles/{_locale}/{year}/{title}.{_format}
blog ANY ANY ANY /blog/{page}
blog_show ANY ANY ANY /blog/{slug}
------------------ -------- -------- ------ ----------------------------------------------You can also get very specific information on a single route by including the route name as the command argument:
1
$ php bin/console debug:router article_showLikewise, if you want to test whether a URL matches a given route, use the
router:match command. This is useful to debug routing issues and find out
which route is associated with the given URL:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
$ php bin/console router:match /blog/my-latest-post
Route "blog_show" matches
+--------------+---------------------------------------------------------+
| Property | Value |
+--------------+---------------------------------------------------------+
| Route Name | blog_show |
| Path | /blog/{slug} |
| Path Regex | #^/blog/(?P<slug>[^/]++)$#sDu |
| Host | ANY |
| Host Regex | |
| Scheme | ANY |
| Method | ANY |
| Requirements | NO CUSTOM |
| Class | Symfony\Component\Routing\Route |
| Defaults | _controller: App\Controller\BlogController:show |
| Options | compiler_class: Symfony\Component\Routing\RouteCompiler |
| | utf8: true |
+--------------+---------------------------------------------------------+