クイックリファレンス

Phoenix ルーティング チートシート

Phoenixルーターのクイックリファレンス:HTTP動詞、resourcesリソースルーティング、パスヘルパー、ネストされたリソース、スコープとパイプライン。

· 公開日

Phoenix Routerは、HTTPリクエストをパイプライン経由でコントローラーのアクションやLiveViewへと効率的に対応付けるルーティング機構を提供します。

ルート定義の確認(Inspecting Routes)

# 定義済みルートとパスヘルパーの一覧表示
mix phx.routes

リソースルーティング(Resource Routing)

# 標準的な7つのRESTfulアクションを一括生成
resources "/users", UserController

# 生成するアクションの絞り込み
resources "/posts", PostController, only: [:index, :show]
resources "/comments", CommentController, except: [:delete]

生成されるRESTfulルート対応表

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

ネストされたヘルパー関数が生成されます:

# 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

関連リファレンス

関連テーマ