The Phoenix Router provides expressive routing for matching HTTP requests to controller actions and LiveViews through pipelines.
Inspecting Routes
# Print all defined routes and path helpers
mix phx.routes
Resource Routing (resources/4)
# Generates all standard RESTful actions
resources "/users", UserController
# Limit generated actions
resources "/posts", PostController, only: [:index, :show]
resources "/comments", CommentController, except: [:delete]
Generated RESTful Route Mapping
| HTTP Verb | Path | Action | Helper Function |
|---|---|---|---|
GET |
/users |
:index |
Routes.user_path(conn, :index) |
GET |
/users/new |
:new |
Routes.user_path(conn, :new) |
POST |
/users |
:create |
Routes.user_path(conn, :create) |
GET |
/users/:id |
:show |
Routes.user_path(conn, :show, id) |
GET |
/users/:id/edit |
:edit |
Routes.user_path(conn, :edit, id) |
PUT / PATCH |
/users/:id |
:update |
Routes.user_path(conn, :update, id) |
DELETE |
/users/:id |
:delete |
Routes.user_path(conn, :delete, id) |
Nested Resources
resources "/users", UserController do
resources "/posts", PostController
end
# Generates:
# Routes.user_post_path(conn, :index, user_id)
# Routes.user_post_path(conn, :show, user_id, post_id)
Scopes & Pipelines
pipeline :browser do
plug :accepts, ["html"]
plug :fetch_session
plug :protect_from_forgery
end
pipeline :api do
plug :accepts, ["json"]
end
scope "/api", MyAppWeb.Api, as: :api do
pipe_through :api
resources "/articles", ArticleController
end