Serializers (Active Model Serializers) in Ruby on Rails

Introduction

Serializers help you control how your data is sent from your Rails app to the outside world. They make your data neat and easy to understand.

When you want to send only specific parts of your database records as JSON to a web client.

When you want to change the names or format of data fields before sending them.

When you want to include related data (like a user's posts) in the JSON response.

When you want to keep your controller code clean by moving JSON formatting elsewhere.

Syntax

Ruby on Rails

class ModelNameSerializer < ActiveModel::Serializer
  attributes :field1, :field2, :field3

  belongs_to :related_model
  has_many :other_related_models

  def custom_field
    # custom logic here
  end
end

The attributes line lists the fields to include in the JSON output.

You can add methods to create custom fields in the JSON.

Examples

This sends only the user's id, name, and email in the JSON.

Ruby on Rails

class UserSerializer < ActiveModel::Serializer
  attributes :id, :name, :email
end

This includes the post's fields and the user who wrote it.

Ruby on Rails

class PostSerializer < ActiveModel::Serializer
  attributes :id, :title, :body
  belongs_to :user
end

This changes the price field to show a dollar sign before the number.

Ruby on Rails

class ProductSerializer < ActiveModel::Serializer
  attributes :id, :name, :price

  def price
    "$#{object.price}"
  end
end

Sample Program

This serializer sends the book's id, title, and the name of its author as a custom field. The controller renders the book as JSON using this serializer automatically.

Ruby on Rails

class BookSerializer < ActiveModel::Serializer
  attributes :id, :title, :author_name

  def author_name
    object.author.name
  end
end

# In controller
class BooksController < ApplicationController
  def show
    book = Book.find(params[:id])
    render json: book
  end
end

Important Notes

Active Model Serializers automatically picks the right serializer if named properly.

Keep serializers simple and focused on formatting data only.

You can nest serializers to include related objects easily.

Summary

Serializers format your Rails data into clean JSON.

They help you choose which fields to send and how to show them.

Use serializers to keep your controllers simple and your API consistent.

Practice

1. What is the main purpose of using Active Model Serializers in a Rails application?

easy

A. To handle database migrations automatically

B. To format and control how Rails models are converted to JSON responses

C. To manage user authentication and sessions

D. To style HTML views with CSS

Solution

1. Step 1: Understand the role of serializers

   Serializers format model data into JSON, deciding which attributes to include.

2. Step 2: Compare with other options

   Database migrations, authentication, and styling are unrelated to serializers.

3. Final Answer:

   To format and control how Rails models are converted to JSON responses -> Option B

4. Quick Check:

   Serializers format JSON = A [OK]

Hint: Serializers shape JSON output, not database or styling [OK]

Common Mistakes:

• Confusing serializers with database migration tools
• Thinking serializers handle user login
• Assuming serializers style HTML pages

2. Which of the following is the correct way to define attributes in an Active Model Serializer?

easy

A. attributes :id, :name, :email

B. attribute :id, :name, :email

C. attrs :id, :name, :email

D. fields :id, :name, :email

Solution

1. Step 1: Recall the syntax for attributes in serializers

   The correct method is attributes followed by symbols for each field.

2. Step 2: Check other options

   attribute (singular), attrs, and fields are not valid methods in Active Model Serializers.

3. Final Answer:

   attributes :id, :name, :email -> Option A

4. Quick Check:

   Use plural 'attributes' method [OK]

Hint: Use plural 'attributes' to list fields in serializer [OK]

Common Mistakes:

• Using singular 'attribute' instead of 'attributes'
• Trying non-existent methods like 'attrs' or 'fields'
• Forgetting to use symbols for attribute names

3. Given this serializer:

class UserSerializer < ActiveModel::Serializer
  attributes :id, :name
  attribute :email
end

What will be the JSON output keys for a user with id=1, name='Alice', email='[e-mail]'?

medium

A. {"id":1,"name":"Alice"}

B. {"id":1,"name":"Alice","email":"[e-mail]"}

C. {"id":1,"name":"Alice", "email":null}

D. NoMethodError due to 'attribute' usage

Solution

1. Step 1: Check serializer attribute methods

   The serializer uses attributes (plural) and attribute (singular). Only attributes is valid; attribute is not a defined method and raises NoMethodError when the class is defined.

2. Step 2: Determine output keys

   The serializer class fails to load due to the undefined method, preventing JSON output.

3. Final Answer:

   NoMethodError due to 'attribute' usage -> Option D

4. Quick Check:

   Undefined 'attribute' method causes error = D [OK]

Hint: Only use plural 'attributes' to include fields [OK]

Common Mistakes:

• Using singular 'attribute' which causes NoMethodError
• Expecting all fields to appear despite syntax error
• Confusing attribute method names

4. Identify the error in this serializer code:

class PostSerializer < ActiveModel::Serializer
  attributes :id, :title

  def title
    object.title.upcase
  end

  def author_name
    object.author.name
  end
end

medium

A. Missing :author_name in attributes list, so it won't appear in JSON

B. Method 'title' should not be defined in serializer

C. Using 'object' is invalid inside serializer methods

D. Attributes list should include :author instead of :author_name

Solution

1. Step 1: Check attributes declaration

   Only :id and :title are declared in attributes, so only these keys appear in JSON.

2. Step 2: Check custom method usage

   Method author_name exists but is not listed in attributes, so it won't be serialized.

3. Final Answer:

   Missing :author_name in attributes list, so it won't appear in JSON -> Option A

4. Quick Check:

   Only declared attributes appear in JSON = B [OK]

Hint: Add custom methods to attributes list to include them [OK]

Common Mistakes:

• Defining methods but forgetting to list them in attributes
• Thinking all methods auto-serialize
• Misusing 'object' inside serializer methods

5. You want to include a nested association in your JSON output using Active Model Serializers. Given these models:

class Article < ApplicationRecord
  belongs_to :author
end

class Author < ApplicationRecord
  has_many :articles
end

And these serializers:

class ArticleSerializer < ActiveModel::Serializer
  attributes :id, :title
  belongs_to :author
end

class AuthorSerializer < ActiveModel::Serializer
  attributes :id, :name
end

What will the JSON output for an article include regarding the author?

hard

A. The author will not be included unless manually added in controller

B. Only the author's id will be included as a number

C. The author will be included as a nested JSON object with :id and :name

D. The JSON will raise an error due to missing author attributes

Solution

1. Step 1: Understand belongs_to in serializer

   Using belongs_to :author in ArticleSerializer includes the author association serialized by AuthorSerializer.

2. Step 2: Check AuthorSerializer attributes

   AuthorSerializer defines :id and :name, so these fields appear nested inside article JSON.

3. Final Answer:

   The author will be included as a nested JSON object with :id and :name -> Option C

4. Quick Check:

   belongs_to includes nested object = C [OK]

Hint: Use belongs_to with serializer to nest associated objects [OK]

Common Mistakes:

• Expecting only author id without serializer
• Thinking associations need manual controller inclusion
• Assuming missing attributes cause errors