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

[0.8.x] add example for POROs, clear up explanation

Browse Source
This commit is contained in:
Liz Abinante 2016-02-09 04:08:25 -08:00
parent 7e2051a369
commit 5c2e61bcfb
1 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -45,18 +45,35 @@ the serializer generator:
$ rails g serializer post $ rails g serializer post
``` ```
### Support for PORO's and other ORM's. ### Support for POROs and other ORMs.
Currently `ActiveModel::Serializers` adds serialization support to all models Currently `ActiveModel::Serializers` adds serialization support to all models
that descend from `ActiveRecord` or include `Mongoid::Document`. If you are that descend from `ActiveRecord` or include `Mongoid::Document`. If you are:
using another ORM, or if you are using objects that are `ActiveModel`
compliant but do not descend from `ActiveRecord` or include - using another ORM, or
`Mongoid::Document`, you must add an include statement for - using objects that are `ActiveModel` compliant but do not descend from
`ActiveModel::SerializerSupport` to make models serializable. If you `ActiveRecord` *or* include `Mongoid::Document`
also want to make collections serializable, you should include
You must add an include statement for `ActiveModel::SerializerSupport` to
make models serializable.
If you also want to make collections serializable, you should include
`ActiveModel::ArraySerializerSupport` into your ORM's `ActiveModel::ArraySerializerSupport` into your ORM's
relation/criteria class. relation/criteria class.
Example model (`app/models/avatar.rb`):
```ruby
class Avatar
include ActiveModel::SerializerSupport
# etc, etc
end
```
If your classes follow the naming conventions prescribed by `ActiveModel`,
you don't need to do anything different in your controller to render the
serialized json.
# ActiveModel::Serializer # ActiveModel::Serializer
All new serializers descend from ActiveModel::Serializer All new serializers descend from ActiveModel::Serializer