You are browsing the Symfony 4 documentation, which changes significantly from Symfony 3.x. If your app doesn't use Symfony 4 yet, browse the Symfony 3.4 documentation.

How to Visualize And Debug Routes

4.1 version

How to Visualize And Debug Routes

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 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
2
3
4
5
6
7
8
$ php bin/console debug:router article_show

# or use part of the name to search for routes
$ php bin/console debug:router blo

  Select one of the matching routes:
  [0] blog
  [1] blog_show

New in version 4.1: The feature to look for partial route names was introduced in Symfony 4.1.

Likewise, 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
$ php bin/console router:match /blog/my-latest-post

Route "blog_show" matches

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.