mirror of
https://github.com/ditkrg/active_model_serializers.git
synced 2026-01-23 06:16:50 +00:00
105 lines
2.5 KiB
Markdown
105 lines
2.5 KiB
Markdown
# Getting Started
|
|
|
|
## Installation
|
|
|
|
### ActiveModel::Serializer is already included on Rails >= 5
|
|
|
|
Add this line to your application's Gemfile:
|
|
|
|
```
|
|
gem 'active_model_serializers'
|
|
```
|
|
|
|
And then execute:
|
|
|
|
```
|
|
$ bundle
|
|
```
|
|
|
|
## Creating a Serializer
|
|
|
|
The easiest way to create a new serializer is to generate a new resource, which
|
|
will generate a serializer at the same time:
|
|
|
|
```
|
|
$ rails g resource post title:string body:string
|
|
```
|
|
|
|
This will generate a serializer in `app/serializers/post_serializer.rb` for
|
|
your new model. You can also generate a serializer for an existing model with
|
|
the serializer generator:
|
|
|
|
```
|
|
$ rails g serializer post
|
|
```
|
|
|
|
The generated seralizer will contain basic `attributes` and
|
|
`has_many`/`has_one`/`belongs_to` declarations, based on the model. For example:
|
|
|
|
```ruby
|
|
class PostSerializer < ActiveModel::Serializer
|
|
attributes :title, :body
|
|
|
|
has_many :comments
|
|
has_one :author
|
|
|
|
end
|
|
```
|
|
|
|
and
|
|
|
|
```ruby
|
|
class CommentSerializer < ActiveModel::Serializer
|
|
attributes :name, :body
|
|
|
|
belongs_to :post_id
|
|
|
|
end
|
|
```
|
|
|
|
### Namespaced Models
|
|
|
|
When serializing a model inside a namespace, such as `Api::V1::Post`, AMS will expect the corresponding serializer to be inside the same namespace (namely `Api::V1::PostSerializer`).
|
|
|
|
### Model Associations and Nested Serializers
|
|
|
|
When declaring a serializer for a model with associations, such as:
|
|
```ruby
|
|
class PostSerializer < ActiveModel::Serializer
|
|
has_many :comments
|
|
end
|
|
```
|
|
AMS will look for `PostSerializer::CommentSerializer` in priority, and fall back to `::CommentSerializer` in case the former does not exist. This allows for more control over the way a model gets serialized as an association of an other model.
|
|
|
|
For example, in the following situation:
|
|
|
|
```ruby
|
|
class CommentSerializer < ActiveModel::Serializer
|
|
attributes :body, :date, :nb_likes
|
|
end
|
|
|
|
class PostSerializer < ActiveModel::Serializer
|
|
has_many :comments
|
|
class CommentSerializer < ActiveModel::Serializer
|
|
attributes :body_short
|
|
end
|
|
end
|
|
```
|
|
|
|
AMS will use `PostSerializer::CommentSerializer` (thus including only the `:body_short` attribute) when serializing a `Comment` as part of a `Post`, but use `::CommentSerializer` when serializing a `Comment` directly (thus including `:body, :date, :nb_likes`).
|
|
|
|
## Rails Integration
|
|
|
|
AMS will automatically integrate with you Rails app, you won't need to update your controller, this is a example of how it will look like:
|
|
|
|
```ruby
|
|
class PostsController < ApplicationController
|
|
|
|
def show
|
|
@post = Post.find(params[:id])
|
|
render json: @post
|
|
end
|
|
|
|
end
|
|
```
|