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

updating readme declaring JsonApi as default adapter

Browse Source
This commit is contained in:
João Moura 2015-05-11 16:21:14 -03:00
parent 2c9c36e21f
commit 738894e5b4
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -8,6 +8,9 @@ AMS does this through two components: **serializers** and **adapters**.
Serializers describe _which_ attributes and relationships should be serialized. Serializers describe _which_ attributes and relationships should be serialized.
Adapters describe _how_ attributes and relationships should be serialized. Adapters describe _how_ attributes and relationships should be serialized.
By default AMS will use the JsonApi Adapter that follows RC3 of the format specified in [jsonapi.org/format](http://jsonapi.org/format).
Check how to change the adapter in the sections bellow.
# RELEASE CANDIDATE, PLEASE READ # RELEASE CANDIDATE, PLEASE READ
This is the master branch of AMS. It will become the `0.10.0` release when it's This is the master branch of AMS. It will become the `0.10.0` release when it's
@ -47,17 +50,17 @@ end
``` ```
Generally speaking, you as a user of AMS will write (or generate) these Generally speaking, you as a user of AMS will write (or generate) these
serializer classes. If you want to use a different adapter, such as a JsonApi, you can serializer classes. If you want to use a different adapter, such as a normal Json adapter without the JsonApi conventions, you can
change this in an initializer: change this in an initializer:
```ruby ```ruby
ActiveModel::Serializer.config.adapter = ActiveModel::Serializer::Adapter::JsonApi ActiveModel::Serializer.config.adapter = ActiveModel::Serializer::Adapter::Json
``` ```
or or
```ruby ```ruby
ActiveModel::Serializer.config.adapter = :json_api ActiveModel::Serializer.config.adapter = :json
``` ```
You won't need to implement an adapter unless you wish to use a new format or You won't need to implement an adapter unless you wish to use a new format or