4.2 レスポンス

フォーマットを設定する

コントローラで出力するフォーマットを決めるにはrespond_toメソッドを使います。

class PostsController < ApplicationController
  def index
    @posts = Post.all
    respond_to do |format|
      format.html
      format.xml  { render xml: @posts }
      format.json { render json: @posts }
    end
  end
end

フォーマットとして指定できる形式は以下になります。

文字列を表示する

文字列を表示するにはrenderメソッドにplainというキーと描画したい文字列のハッシュを指定します。

class PostsController < ApplicationController
  def text
    render plain: 'このテキストは描画されます。'
  end
end

JSONを表示する

JSONを表示するにはrenderメソッドにjsonというキーと描画したいオブジェクトのハッシュを指定します。

class PostsController < ApplicationController
  def show
    @post = Post.find(1)
    render json: @post
  end
end

XMLを表示する

XMLを表示するにはrenderメソッドにxmlというキーと描画したいオブジェクトのハッシュを指定します。

class PostsController < ApplicationController
  def show
    @post = Post.find(1)
    render xml: @post
  end
end

ステータスコードを設定する

ステータスコードを指定するときはheadメソッドを使います。

class PostsController < ApplicationController
  def show
    @post = Post.find(1)
    unless @post
      head :not_found
    end
  end
end

100番台

200番台

300番台

400番台

500番台

使用するレイアウトを設定する

layoutメソッドを使うと使用するレイアウトを指定することができます。 指定しない場合はapp/views/layouts/application.html.erbがレイアウトとして利用されます。

class PostsController < ApplicationController

  layout 'admin' # adminという管理画面用のレイアウトを指定

  def show
    @post = Post.find(1)
  end
end

使用するテンプレートを設定する

デフォルトではrenderメソッドを省略するとアクションの名前のテンプレートが呼ばれます。 renderメソッドを利用することで使用したいテンプレートを変更することができます。

他のアクションのテンプレートを呼び出す

class PostsController < ApplicationController
  def create
    @post = Post.create
    render :show # showアクションのテンプレートを呼び出す
  end
end

パスを指定してテンプレートを呼び出す

class PostsController < ApplicationController
  def create
    @post = Post.create
    render 'admin/posts/show' # テンプレートのパスを指定
  end
end

フラッシュメッセージを表示する

フラッシュメッセージは簡易的なメッセージを表示することができる機能です。 リクエストごとにクリアされるflashというハッシュに格納したテキストを利用することができます。

格納時にキーを指定することができます。

メッセージの格納

flash[:notice] = '注意！'

格納したメッセージの削除

flash.discard(:notice)

ビューで表示する

<div class="alert">
  <%= flash[:notice] %>
</div>

ファイルをダウンロードできるようにする

ファイルをダウンロードさせるにはsend_fileメソッドを使います。

class PostsController < ApplicationController
  # ディスク上に生成・保存済みのファイルを送信する
  def download_report
    post = Post.find(params[:id])
    send_file(
      "#{Rails.root}/files/post/#{post.id}.pdf", # ファイルのパス
      filename: "#{post.title}.pdf",             # 出力するファイル名
      type: "application/pdf"                    # Content-Type
    )
  end
end