shallowオプションとは
ルーティングの記述を複雑にせず、かつ深いネストを作らないというバランスを保つことのできるオプションのこと。
簡単に言うと、rails routesした時のURLを短く分かりやすくしてくれるもの。
shallowオプションの実例
オプション無
resources :posts, only: %i(index show new create destroy) do
resources :likes, only: %i(create destroy)
end
#URLを確認
$rails routes -c likes
Prefix Verb URI Pattern Controller#Action
post_likes POST /posts/:post_id/likes(.:format) likes#create
post_like DELETE /posts/:post_id/likes/:id(.:format) likes#destroy
destroyアクションの/posts/:post_id/likes/:id(.:format)が見づらくなっている。これをshallowオプションで見やすくする。
オプション有
resources :posts, only: %i(index show new create destroy) do
resources :likes, only: %i(create destroy), shallow: true
end
#URLを確認
$ rails routes -c likes
Prefix Verb URI Pattern Controller#Action
post_likes POST /posts/:post_id/likes(.:format) likes#create
like DELETE /likes/:id(.:format) likes#destroy
destroyアクションの/posts/:post_id/likes/:id(.:format)が/likes/:id(.:format)に短く変更され簡潔なURLになった。
今回は子リソースにshallowオプションをつけた例だったが、親リソースに直接shallowオプションを指定することもできる。
記述方法はとても簡単で、例にもあるようにshallow: trueを追加するだけである。