Generates a route to handle a connect request to the given path.

connect("/events/:id", EventController, :action)

See match/5 for options.

Generates a route to handle a delete request to the given path.

delete("/events/:id", EventController, :action)

See match/5 for options.

Forwards a request at the given path to a plug.

All paths that match the forwarded prefix will be sent to the forwarded plug. This is useful for sharing a router between applications or even breaking a big router into smaller ones. The router pipelines will be invoked prior to forwarding the connection.

However, we don't advise forwarding to another endpoint. The reason is that plugs defined by your app and the forwarded endpoint would be invoked twice, which may lead to errors.

Examples

scope "/", MyApp do
  pipe_through [:browser, :admin]

  forward "/admin", SomeLib.AdminDashboard
  forward "/api", ApiRouter
end

Generates a route to handle a get request to the given path.

get("/events/:id", EventController, :action)

See match/5 for options.

Generates a route to handle a head request to the given path.

head("/events/:id", EventController, :action)

See match/5 for options.

Generates a route match based on an arbitrary HTTP method.

Useful for defining routes not included in the builtin macros.

The catch-all verb, :*, may also be used to match all HTTP methods.

Options

• :as - configures the named helper exclusively. If false, does not generate a helper.
• :alias - configure if the scope alias should be applied to the route. Defaults to true, disables scoping if false.
• :log - the level to log the route dispatching under, may be set to false. Defaults to :debug
• :host - a string containing the host scope, or prefix host scope, ie "foo.bar.com", "foo."
• :private - a map of private data to merge into the connection when a route matches
• :assigns - a map of data to merge into the connection when a route matches
• :metadata - a map of metadata used by the telemetry events and returned by route_info/4
• :trailing_slash - a boolean to flag whether or not the helper functions append a trailing slash. Defaults to false.

Examples

match(:move, "/events/:id", EventController, :move)

match(:*, "/any", SomeController, :any)

Generates a route to handle a options request to the given path.

options("/events/:id", EventController, :action)

See match/5 for options.

Generates a route to handle a patch request to the given path.

patch("/events/:id", EventController, :action)

See match/5 for options.

Defines a list of plugs (and pipelines) to send the connection through.

See pipeline/2 for more information.

Defines a plug pipeline.

Pipelines are defined at the router root and can be used from any scope.

Examples

pipeline :api do
  plug :token_authentication
  plug :dispatch
end

A scope may then use this pipeline as:

scope "/" do
  pipe_through :api
end

Every time pipe_through/1 is called, the new pipelines are appended to the ones previously given.

Defines a plug inside a pipeline.

See pipeline/2 for more information.

Generates a route to handle a post request to the given path.

post("/events/:id", EventController, :action)

See match/5 for options.

Generates a route to handle a put request to the given path.

put("/events/:id", EventController, :action)

See match/5 for options.

See resources/4.

See resources/4.

Defines "RESTful" routes for a resource.

The given definition:

resources "/users", UserController

will include routes to the following actions:

• GET /users => :index
• GET /users/new => :new
• POST /users => :create
• GET /users/:id => :show
• GET /users/:id/edit => :edit
• PATCH /users/:id => :update
• PUT /users/:id => :update
• DELETE /users/:id => :delete

Options

This macro accepts a set of options:

• :only - a list of actions to generate routes for, for example: [:show, :edit]
• :except - a list of actions to exclude generated routes from, for example: [:delete]
• :param - the name of the parameter for this resource, defaults to "id"
• :name - the prefix for this resource. This is used for the named helper and as the prefix for the parameter in nested resources. The default value is automatically derived from the controller name, i.e. UserController will have name "user"
• :as - configures the named helper exclusively
• :singleton - defines routes for a singleton resource that is looked up by the client without referencing an ID. Read below for more information

Singleton resources

When a resource needs to be looked up without referencing an ID, because it contains only a single entry in the given context, the :singleton option can be used to generate a set of routes that are specific to such single resource:

• GET /user => :show
• GET /user/new => :new
• POST /user => :create
• GET /user/edit => :edit
• PATCH /user => :update
• PUT /user => :update
• DELETE /user => :delete

Usage example:

resources "/account", AccountController, only: [:show], singleton: true

Nested Resources

This macro also supports passing a nested block of route definitions. This is helpful for nesting children resources within their parents to generate nested routes.

The given definition:

resources "/users", UserController do
  resources "/posts", PostController
end

will include the following routes:

user_post_path  GET     /users/:user_id/posts           PostController :index
user_post_path  GET     /users/:user_id/posts/:id/edit  PostController :edit
user_post_path  GET     /users/:user_id/posts/new       PostController :new
user_post_path  GET     /users/:user_id/posts/:id       PostController :show
user_post_path  POST    /users/:user_id/posts           PostController :create
user_post_path  PATCH   /users/:user_id/posts/:id       PostController :update
                PUT     /users/:user_id/posts/:id       PostController :update
user_post_path  DELETE  /users/:user_id/posts/:id       PostController :delete

Returns the compile-time route info and runtime path params for a request.

The path can be either a string or the path_info segments.

A map of metadata is returned with the following keys:

• :log - the configured log level. For example :debug
• :path_params - the map of runtime path params
• :pipe_through - the list of pipelines for the route's scope, for example [:browser]
• :plug - the plug to dipatch the route to, for example AppWeb.PostController
• :plug_opts - the options to pass when calling the plug, for example: :index
• :route - the string route pattern, such as "/posts/:id"

Examples

iex> Phoenix.Router.route_info(AppWeb.Router, "GET", "/posts/123", "myhost")
%{
  log: :debug,
  path_params: %{"id" => "123"},
  pipe_through: [:browser],
  plug: AppWeb.PostController,
  plug_opts: :show,
  route: "/posts/:id",
}

iex> Phoenix.Router.route_info(MyRouter, "GET", "/not-exists", "myhost")
:error

Defines a scope in which routes can be nested.

Examples

scope path: "/api/v1", as: :api_v1, alias: API.V1 do
  get "/pages/:id", PageController, :show
end

The generated route above will match on the path "/api/v1/pages/:id" and will dispatch to :show action in API.V1.PageController. A named helper api_v1_page_path will also be generated.

Options

The supported options are:

• :path - a string containing the path scope.
• :as - a string or atom containing the named helper scope. When set to false, it resets the nested helper scopes.
• :alias - an alias (atom) containing the controller scope. When set to false, it resets all nested aliases.
• :host - a string containing the host scope, or prefix host scope, ie "foo.bar.com", "foo."
• :private - a map of private data to merge into the connection when a route matches
• :assigns - a map of data to merge into the connection when a route matches
• :log - the level to log the route dispatching under, may be set to false. Defaults to :debug
• :trailing_slash - whether or not the helper functions append a trailing slash. Defaults to false.

Define a scope with the given path.

This function is a shortcut for:

scope path: path do
  ...
end

Examples

scope "/api/v1", as: :api_v1 do
  get "/pages/:id", PageController, :show
end

Defines a scope with the given path and alias.

This function is a shortcut for:

scope path: path, alias: alias do
  ...
end

Examples

scope "/api/v1", API.V1, as: :api_v1 do
  get "/pages/:id", PageController, :show
end

Returns the full alias with the current scope's aliased prefix.

Useful for applying the same short-hand alias handling to other values besides the second argument in route definitions.

Examples

scope "/", MyPrefix do
  get "/", ProxyPlug, controller: scoped_alias(__MODULE__, MyController)
end

Generates a route to handle a trace request to the given path.

trace("/events/:id", EventController, :action)

See match/5 for options.