cheatsheets/phoenix-routing.md

title	category
Phoenix: Routing	Elixir

mix phoenix.routes

Single routes

get "/", PageController, :index

Also: put post patch options delete head

Resources

resources "/users", UserController
resources "/users", UserController, only: [:index, :show]
resources "/users", UserController, except: [:delete]

  as: :person    # helper name (person_path)
  name: :person  # ...?
  param: :id     # name of parameter for this resource

Method	Path	Helper
GET	/users	user_path(:index)
GET	/users/new	user_path(:new)
GET	/users/:id	user_path(:show, user)
GET	/users/:id/edit	user_path(:edit, user)
POST	/users	user_path(:create, user)
PATCH/PUT	/users/:id	user_path(:update, user)
DELETE	/users/:id	user_path(:delete, user)

Path helpers

user_path(Endpoint, :index)                 #=> /users
user_path(Endpoint, :show, 17)              #=> /users/17
user_path(Endpoint, :show, %User{id: 17})   #=> /users/17
user_path(Endpoint, :show, 17, admin: true) #=> /users/17?admin=true

user_path(Endpoint, :index) #=> "http://localhost:4000/users"

MyApp.Router.Helpers.user_path(MyApp.Endpoint, :index)

Nested resources

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

user_post_path(:index, 17)     #=> /users/17/posts
user_post_path(:show, 17, 12)  #=> /users/17/posts/12

Scoped routes

scope "/admin" do
  pipe_through :browser
  resources "/reviews", MyApp.Admin.ReviewController
end
# reviews_path() -> /admin/reviews

scope "/admin", as: :admin do: ... end
# admin_reviews_path() -> /admin/reviews