ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-23 06:16:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

#133 adding documentation for :serializer and :polymorphic options on associations

Browse Source
This commit is contained in:
Gary S. Weaver 2012-10-08 17:17:14 -04:00
parent bea38dd73a
commit 257adfc80e
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -328,6 +328,37 @@ class PostSerializer < ActiveModel::Serializer
end
```
Use the `:serializer` option to specify a custom serializer class:
```ruby
class PostSerializer < ActiveModel::Serializer
attributes :id, :title, :body
has_one :author
has_many :comments, :serializer => CommentShortSerializer
def include_associations!
include! :author if scope.admin?
include! :comments unless object.comments_disabled?
end
end
```
Use the `:polymorphic` option to specify an association that is polymorphic (STI):
```ruby
class PostSerializer < ActiveModel::Serializer
attributes :id, :title, :body
has_one :author
has_many :comments
has_one :reviewer, :polymorphic => true
def include_associations!
include! :author if scope.admin?
include! :comments unless object.comments_disabled?
end
end
```
## Embedding Associations
By default, associations will be embedded inside the serialized object. So if