<p>Railsでは、アプリケーション内の異なるURLにリクエストをマッピングするためにルーティングが使われています。</p>
<p>その中でも、RESTfulなルーティングはRailsの中核的な概念であり、効率的でシンプルなURL構造を提供しています。</p>
<p>この記事では、RailsのルーティングとRESTfulなルートについて詳しく解説します。</p>
<h2>ルーティングの基本</h2>
<p>Railsのルーティングは<code>config/routes.rb</code>ファイルに記載します。</p>
<p>記載する内容としては、HTTPメソッドとURLパス、そしてそれに対応するコントローラーのアクションを記載します。</p>
<p>例えば、下記のように書くことで特定のURLにリクエストをルーティングすることができます。</p>
<pre><code class="language-ruby"># config/routes.rb
Rails.application.routes.draw do
  get &#x27;/products&#x27;, to: &#x27;products#index&#x27;
  post &#x27;/products&#x27;, to: &#x27;products#create&#x27;
  get &#x27;/products/:id&#x27;, to: &#x27;products#show&#x27;
  put &#x27;/products/:id&#x27;, to: &#x27;products#update&#x27;
  delete &#x27;/products/:id&#x27;, to: &#x27;products#destroy&#x27;
end
</code></pre>
<p>上記の例では/productsに対して、GETリクエストがProductsControllerのindexアクションに、POSTリクエストがcreateアクションにマッピングされています。</p>
<p>また、/products/:idのようなパスは動的セグメントと呼ばれ、:idには異なる値を入れることができます。</p>
<h2>RESTfulルーティング</h2>
<p>RESTの性質を持っているルート設計のことをRESTfulと言います。Railsのルート設計はこのRESTfulとなります。
※ RESTfulでないルート設計も可能にはなります。しかしRailsにはRESTfulなルート設計が前提の機能も存在するため、注意が必要となります。</p>
<p>RESTfulなルーティングでは、リソース指向のURLを定義することが一般的となっています。</p>
<p>これにより、CRUD操作（Create, Read, Update, Delete）に対応する標準的なHTTPメソッドであるGET・POST・PATCH・PUT・DELETEを使用できます。</p>
<p>例えば下記のようにresourcesメソッドを使用すると</p>
<pre><code class="language-ruby"># config/routes.rb
Rails.application.routes.draw do
  resources :articles
end
</code></pre>
<p>以下のようなRESTfulなルーティングが自動的に定義されます</p>
<pre><code class="language-bash">     articles GET    /articles(.:format)           articles#index
              POST   /articles(.:format)           articles#create
  new_article GET    /articles/new(.:format)       articles#new
 edit_article GET    /articles/:id/edit(.:format)  articles#edit
      article GET    /articles/:id(.:format)       articles#show
              PATCH  /articles/:id(.:format)       articles#update
              PUT    /articles/:id(.:format)       articles#update
              DELETE /articles/:id(.:format)       articles#destroy
</code></pre>
<h2>ヘルパーメソッド</h2>
<p>RESTfulなルーティングでは、ルートヘルパーメソッドも自動的に生成されます。これらのヘルパーメソッドを使うと、コントローラー内やビューで簡潔にURLを生成することができます。</p>
<h3>ルートヘルパーメソッド</h3>
<p>ルートヘルパーメソッドは、ルートURLへのパスを生成するためのメソッドになります。</p>
<p>これにより、URLを直接記述する代わりに、ルート名を使用してリンクを作成することができます。</p>
<p>例えば、下記でrouteを生成した場合は</p>
<pre><code class="language-ruby"># config/routes.rb
Rails.application.routes.draw do
  resources :articles
end
</code></pre>
<p><code>articles_path</code>や<code>new_article_path</code>等のルートヘルパーメソッドが自動的に生成されます。</p>
<h4>_pathと_urlについて</h4>
<p>ルートヘルパーメソッドを使うにあたって<code>Prefix+_path</code>と<code>Prefix+_url</code>があります。</p>
<p>違いとしては_pathがルート以下の文字列を返すのに対して、_urlはドメインを含む完全なURLを返すという違いがあります。</p>
<pre><code>  root_path =&gt; &#x27;/&#x27; ※ルート以下の文字列を返す
  root_url  =&gt; &#x27;https://example.com/&#x27; ※完全なURLの文字列を返す

  articles_path =&gt; &#x27;/articles&#x27;
  articles_url  =&gt; &#x27;https://example.com/articles&#x27;
</code></pre>
<p>_pathと_urlの使い分けですが、「リダイレクトするときは_urlを使用する。それ以外は_pathを使う」とするとよさそうです。</p>
<h3>リンクヘルパーメソッド</h3>
<p>リンクヘルパーメソッドは、指定したURLやルート名に基づいてリンクを作成するためのメソッドになります。</p>
<p>これにより、簡単にリンクを生成することができます。</p>
<pre><code class="language-ruby">&lt;%= link_to &#x27;Show Articles&#x27;, articles_path(@article) %&gt;
&lt;%= link_to &#x27;Edit Article&#x27;, edit_article_path(@article) %&gt;
&lt;%= link_to &#x27;Delete Article&#x27;, articles_path(@article), method: :delete, data: { confirm: &#x27;Are you sure?&#x27; } %&gt;
</code></pre>
<p>そのほか、フォームヘルパーメソッドやテキストヘルパーメソッド等ありますが、今回の趣旨とは異なるので説明省略します。</p>
<h2>ルートの名前付け</h2>
<p>ルーティングに名前を付けることで、ルートヘルパーのメソッド名が変わります。これにより、ルートをより意味のある名前で参照することができます。</p>
<pre><code class="language-ruby"># config/routes.rb
Rails.application.routes.draw do
  resources :products, path: &#x27;items&#x27;, as: &#x27;items&#x27;
end
</code></pre>
<p>これにより、以下のようなルートヘルパーが使えるようになります。</p>
<ul>
<li>items_path</li>
<li>items_url</li>
<li>item_path(@item)</li>
</ul>
<pre><code class="language-bash">    items GET    /items(.:format)              products#index
          POST   /items(.:format)              products#create
 new_item GET    /items/new(.:format)          products#new
edit_item GET    /items/:id/edit(.:format)     products#edit
     item GET    /items/:id(.:format)          products#show
          PATCH  /items/:id(.:format)          products#update
          PUT    /items/:id(.:format)          products#update
          DELETE /items/:id(.:format)          products#destroy
</code></pre>

RailsのルーティングとRESTfulルートについて解説している記事です。ユースケース等詳しくまとめています。

Ruby on RailsのルーティングとRESTfulルート

Railsでは、アプリケーション内の異なるURLにリクエストをマッピングするためにルーティングが使われています。

その中でも、RESTfulなルーティングはRailsの中核的な概念であり、効率的でシンプルなURL構造を提供しています。

この記事では、RailsのルーティングとRESTfulなルートについて詳しく解説します。

## ルーティングの基本
Railsのルーティングは`config/routes.rb`ファイルに記載します。

記載する内容としては、HTTPメソッドとURLパス、そしてそれに対応するコントローラーのアクションを記載します。

例えば、下記のように書くことで特定のURLにリクエストをルーティングすることができます。

```ruby
# config/routes.rb
Rails.application.routes.draw do
  get '/products', to: 'products#index'
  post '/products', to: 'products#create'
  get '/products/:id', to: 'products#show'
  put '/products/:id', to: 'products#update'
  delete '/products/:id', to: 'products#destroy'
end
```

上記の例では/productsに対して、GETリクエストがProductsControllerのindexアクションに、POSTリクエストがcreateアクションにマッピングされています。

また、/products/:idのようなパスは動的セグメントと呼ばれ、:idには異なる値を入れることができます。

## RESTfulルーティング
RESTの性質を持っているルート設計のことをRESTfulと言います。Railsのルート設計はこのRESTfulとなります。
※ RESTfulでないルート設計も可能にはなります。しかしRailsにはRESTfulなルート設計が前提の機能も存在するため、注意が必要となります。

RESTfulなルーティングでは、リソース指向のURLを定義することが一般的となっています。

これにより、CRUD操作（Create, Read, Update, Delete）に対応する標準的なHTTPメソッドであるGET・POST・PATCH・PUT・DELETEを使用できます。

例えば下記のようにresourcesメソッドを使用すると

```ruby
# config/routes.rb
Rails.application.routes.draw do
  resources :articles
end
```

以下のようなRESTfulなルーティングが自動的に定義されます

```bash
     articles GET    /articles(.:format)           articles#index
              POST   /articles(.:format)           articles#create
  new_article GET    /articles/new(.:format)       articles#new
 edit_article GET    /articles/:id/edit(.:format)  articles#edit
      article GET    /articles/:id(.:format)       articles#show
              PATCH  /articles/:id(.:format)       articles#update
              PUT    /articles/:id(.:format)       articles#update
              DELETE /articles/:id(.:format)       articles#destroy
```

## ヘルパーメソッド
RESTfulなルーティングでは、ルートヘルパーメソッドも自動的に生成されます。これらのヘルパーメソッドを使うと、コントローラー内やビューで簡潔にURLを生成することができます。

### ルートヘルパーメソッド
ルートヘルパーメソッドは、ルートURLへのパスを生成するためのメソッドになります。

これにより、URLを直接記述する代わりに、ルート名を使用してリンクを作成することができます。

例えば、下記でrouteを生成した場合は

```ruby
# config/routes.rb
Rails.application.routes.draw do
  resources :articles
end
```

`articles_path`や`new_article_path`等のルートヘルパーメソッドが自動的に生成されます。

#### _pathと_urlについて
ルートヘルパーメソッドを使うにあたって`Prefix+_path`と`Prefix+_url`があります。

違いとしては_pathがルート以下の文字列を返すのに対して、_urlはドメインを含む完全なURLを返すという違いがあります。

```
  root_path => '/' ※ルート以下の文字列を返す
  root_url  => 'https://example.com/' ※完全なURLの文字列を返す

  articles_path => '/articles'
  articles_url  => 'https://example.com/articles'
```

_pathと_urlの使い分けですが、「リダイレクトするときは_urlを使用する。それ以外は_pathを使う」とするとよさそうです。

### リンクヘルパーメソッド
リンクヘルパーメソッドは、指定したURLやルート名に基づいてリンクを作成するためのメソッドになります。

これにより、簡単にリンクを生成することができます。

```ruby
<%= link_to 'Show Articles', articles_path(@article) %>
<%= link_to 'Edit Article', edit_article_path(@article) %>
<%= link_to 'Delete Article', articles_path(@article), method: :delete, data: { confirm: 'Are you sure?' } %>
```

そのほか、フォームヘルパーメソッドやテキストヘルパーメソッド等ありますが、今回の趣旨とは異なるので説明省略します。

## ルートの名前付け
ルーティングに名前を付けることで、ルートヘルパーのメソッド名が変わります。これにより、ルートをより意味のある名前で参照することができます。

```ruby
# config/routes.rb
Rails.application.routes.draw do
  resources :products, path: 'items', as: 'items'
end
```

これにより、以下のようなルートヘルパーが使えるようになります。

- items_path
- items_url
- item_path(@item)

```bash
    items GET    /items(.:format)              products#index
          POST   /items(.:format)              products#create
 new_item GET    /items/new(.:format)          products#new
edit_item GET    /items/:id/edit(.:format)     products#edit
     item GET    /items/:id(.:format)          products#show
          PATCH  /items/:id(.:format)          products#update
          PUT    /items/:id(.:format)          products#update
          DELETE /items/:id(.:format)          products#destroy
```


railsでgemのchartjs-rorを利用してchart.jsでグラフを表示させるときに、jsではなくrubyでtooltipの単位を定義する方法のお話です。

railsでjsではなくrubyでtooltipの単位を設定するときの話

Railsのクラスメソッドとインスタンスメソッドについて調べた際のまとめです。それぞれの違いから使い方まで幅広くまとめています。

Railsにおけるクラスメソッドとインスタンスメソッドの違いについて

この記事では、Dockerを使用してRails7 + PostgreSQL + esbuildの環境構築の方法を解説しています。

DockerでRails7 + PostgreSQL + esbuildの環境を構築する方法

Dockerで建てたRuby on rails v7環境で「undefined method `devise' for 〜」が発生した際の解決方法の備忘録です。

Dockerで建てたrails7環境で「undefined method `devise' for 〜」が発生した話

Ruby on Railsにおけるresourceとresourcesの違いについて解説している記事です。ユースケース等詳しくまとめています。

CATEGORY

Ruby on RailsのルーティングとRESTfulルート

実装やエラーが解決できない場合

OTHER ARTICLES

railsでjsではなくrubyでtooltipの単位を設定するときの話

Railsにおけるクラスメソッドとインスタンスメソッドの違いについて

DockerでRails7 + PostgreSQL + esbuildの環境を構築する方法

Dockerで建てたrails7環境で「undefined method `devise' for 〜」が発生した話

Ruby on RailsのルーティングとRESTfulルート

Ruby on Railsにおけるresourceとresourcesの違い

CATEGORY

TAG