今回は、Usersリソースを中心に、追加構成としてAPIディレクトリを追加してみたり、新たなメソッドとしてsortメソッドを追加したときのパスの状態などを設定するパターンで見ていく
早見表
| 種類 | パス | クラス | ファイルパス |
|---|---|---|---|
| scope | /api/users | UsersController | /users_controller.rb |
| namespace | /api/users | Api::UsersController | /api/users_controller.rb |
| module | /users | Api::UsersController | /api/users_controller.rb |
| member | /users/:id/sort | ||
| collection | /users/sort |
Controllersのディレクトリ構成と、ルーティング
scope
routes.rb
# /api/users
scope :api do
resources :users
end
ディレクトリ構成
/controllers--
|
|--application.rb
|
|--users_controller.rb
controller.rb
class UsersController < ApplicationController
end
namespace
routes.rb
# /api/users
namespace :api do
resources :users
end
ディレクトリ構成
controllers/-
|
|--application.rb
|
|--api/-
|
|--users_controller.rb
controller.rb
class Api::UsersController < ApplicationController
end
module
routes.rb
# /users
scope module: :api do
resources :users
end
ディレクトリ構成
controllers/-
|
|--application.rb
|
|--api/-
|
|--users_controller.rb
controller.rb
class Api::UsersController < ApplicationController
end
まったく新しいパスを作る
member
routes.rb
# idを伴うパス /users/:id/sort
resources :users do
member do
get :sort
end
end
省略形
routes.rb
resources :users do
get :sort, on: :member
end
collection
routes.rb
# idを伴わないパス /users/sort
resources :users do
collection do
get :sort
end
end
省略形
routes.rb
resources :users do
get :sort, on: :collection
end