ditkrg/active_model_serializers
5
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-25 07:16:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

minor updates and TYPOs

Browse Source
This commit is contained in:
João M. D. Moura
2015-07-16 23:29:03 -04:00
parent 456f9158ca
commit 63436c73e8
3 changed files with 13 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/general/adapters.md
View File

@@ -3,8 +3,7 @@
AMS does this through two components: **serializers** and **adapters**.
Serializers describe _which_ attributes and relationships should be serialized.
Adapters describe _how_ attributes and relationships should be serialized.
You can use one of the built-in adapters (```FlattenJSON``` is the default one) or create one by your one but you won't need to implement an adapter unless you wish to use a new format or
media type with AMS.
You can use one of the built-in adapters (```FlattenJSON``` is the default one) or create one by yourself, but you won't need to implement an adapter unless you wish to use a new format or media type with AMS.
## Built in Adapters
@@ -15,12 +14,12 @@ Doesn't follow any specifc convention.
### JSON
It also generates a json response but always with a root key. The root key **can't be overridden**, and will be automatically defined accordingly with the objects being serialized.
It also generates a json response but always with a root key. The root key **can't be overridden**, and will be automatically defined accordingly to the objects being serialized.
Doesn't follow any specifc convention.
### JSONAPI
This adapter follows 1.0 of the format specified in
This adapter follows **version 1.0** of the format specified in
[jsonapi.org/format](http://jsonapi.org/format). It will include the associated
resources in the `"included"` member when the resource names are included in the
`include` option.
@@ -31,9 +30,9 @@ resources in the `"included"` member when the resource names are included in the
render @posts, include: 'authors,comments'
```
## Choose an Adapter
## Choosing an adapter
If you want to use a different adapter, such as a JsonApi, you can change this in an initializer:
If you want to use a different adapter, such as JsonApi, you can change this in an initializer:
```ruby
ActiveModel::Serializer.config.adapter = ActiveModel::Serializer::Adapter::JsonApi
@@ -45,7 +44,7 @@ or
ActiveModel::Serializer.config.adapter = :json_api
```
If you want to have a root key on your responses you should use the Json adapter, instead of the default FlattenJson:
If you want to have a root key in your responses you should use the Json adapter, instead of the default FlattenJson:
```ruby
ActiveModel::Serializer.config.adapter = :json