はじめに
jbuilder は、Ruby on Rails で JSON を生成するための Gem です。
この記事では、jbuilder の基本的な使い方をまとめてみました。
環境設定
Gem のインストール
Gemfile に jbuilder を追加するために、以下の行を追記します。
gem 'jbuilder'
その後、以下のコマンドを実行して、Gem をインストールします。
bundle install
使い方
controller ファイルの設定
コントローラーで、JSON 形式でデータを返すように設定します。
例えば、respond_toメソッドを使用して、JSON 形式のレスポンスを許可することができます。
class UsersController < ApplicationController
def index
@users = User.all
respond_to do |format|
format.json { render json: @users }
end
end
end
基本的な JSON の生成
app/views ディレクトリ内に、.jbuilder 拡張子のファイルを作成します。
例えば、ユーザーリストを表示するための index.json.jbuilder を作成する場合、以下のような内容になります。
json.array! @users, :id, :name, :email
@users に格納されたユーザーの配列を JSON 形式で出力します。各ユーザーの id、name、email が JSON 配列の要素として表示されます。
array! メソッド
配列の各要素に対してブロックを実行し、その結果を JSON 配列として出力します。
json.array! @users do |user|
json.id user.id
json.name user.name
json.email user.email
end
[
{
"id": 1,
"name": "Alice",
"email": "alice@example.com"
},
{
"id": 2,
"name": "Bob",
"email": "bob@example.com"
}
]
この例では、@users 配列の各ユーザーについて、ブロック内で json.id, json.name, json.email を使用し、それぞれのユーザーの id、name、email の情報を JSON 配列に変換しています。
extract! メソッド
特定のオブジェクトから複数の属性を一括で抽出し、JSON オブジェクトを構築することができます。
json.extract! @user, :id, :name, :email
[
{
"id": 1,
"name": "Alice",
"email": "alice@example.com"
},
]
特定のユーザー（@user）から id、name、email のみを選択的に抽出し、JSON オブジェクトに変換しています。
例えば、ユーザーオブジェクトに status、date_of_birth、address などの他の属性が存在しても、指定された id、name、email のみが JSON 出力に含まれます。
merge! メソッド
与えられたハッシュやオブジェクトの内容を現在の JSON オブジェクトにマージします。
json.array! @users do |user|
json.merge! status: user.status
end
[
{
"id": 1,
"name": "Alice",
"email": "alice@example.com",
"status": "active"
},
{
"id": 2,
"name": "Bob",
"email": "bob@example.com",
"status": "inactive"
}
]
この例では、各ユーザーの ID、名前、メールアドレスに加えて、単一の status 属性を追加しています。
user.attributes と記述すると、オブジェクトの中身のすべての値を返すことができます。
json.array! @users do |user|
json.merge! user.attributes
end
[
{
"id": 1,
"name": "Alice",
"email": "alice@example.com",
"status": "active",
"date_of_birth": "1990-01-01",
"address": "123 Main Street"
},
{
"id": 2,
"name": "Bob",
"email": "bob@example.com",
"status": "inactive",
"date_of_birth": "1992-02-02",
"address": "456 Elm Street"
}
]
この例では、ユーザーの全属性を JSON オブジェクトにマージしています。
参考