読者です 読者をやめる 読者になる 読者になる

rablを使ってRailsのAPIレスポンスを簡潔に定義する

Ruby/Rails

コントローラでJSONレスポンスを定義する場合、

class EntriesController < ApplicationController
  respond_to :json

  def index
    @entries = Entry.all
    respond_with @entries.to_json(:only => :title, :body, :include => {
      :user => { :only => :name },
      :comment => { :only => :name },
      :image => { :only => :file }
    })
  end
end

などと、to_jsonまたはas_jsonで:onlyや:includeオプションを使ってフィールドを指定できます。ただ、これでは冗長だし、より複雑な構造のレスポンスを定義するとなると面倒です。そこで、簡潔に複雑な構造を定義するためにrablというgemを使います。

gem 'rabl'

rablはjsonやxmlなどのAPIレスポンスを記述するためのDSLです。rablを使ってJSONレスポンスを書き換えます。

# app/views/entries/index.json.rabl

collection @entries
attributes :title, :body

child(:user) do
  attributes :name
end

child(:comments) do
  attributes :name
end

child(:images) do
  node(:thumb) {|image| image.file.thumb.url }
  node(:main) {|image| image.file.main.url }
end

nodeを使うと、to_jsonの:methodオプションと同じことができるので、構造の深い部分にある値を取得したいときに便利です。
rablで定義することによってコントローラもスリムになります。

class EntriesController < ApplicationController
  def index
    @entries = Entry.all
  end
end

レスポンスはcurlで確認できます。

$ curl http://localhost:3000/entries.json