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

Update outside_controller_use.md (#2047)

Browse Source 
* Update outside_controller_use.md

Provide example for options parameter when serializing a resource.
This commit is contained in:
Nick Ottrando 2017-02-08 13:06:31 -08:00 committed by Benjamin Fleischer
parent 58e3983e4c
commit a9d533d916
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/howto/outside_controller_use.md
View File

@ -10,8 +10,8 @@ In ActiveModelSerializers versions 0.10 or later, serializing resources outside
# Create our resource # Create our resource
post = Post.create(title: "Sample post", body: "I love Active Model Serializers!") post = Post.create(title: "Sample post", body: "I love Active Model Serializers!")
# Optional options parameters # Optional options parameters for both the serializer and instance
options = {} options = {serializer: PostDetailedSerializer, username: 'sample user'}
# Create a serializable resource instance # Create a serializable resource instance
serializable_resource = ActiveModelSerializers::SerializableResource.new(post, options) serializable_resource = ActiveModelSerializers::SerializableResource.new(post, options)
@ -20,6 +20,7 @@ serializable_resource = ActiveModelSerializers::SerializableResource.new(post, o
model_json = serializable_resource.as_json model_json = serializable_resource.as_json
``` ```
The object that is passed to `ActiveModelSerializers::SerializableResource.new` can be a single resource or a collection. The object that is passed to `ActiveModelSerializers::SerializableResource.new` can be a single resource or a collection.
The additional options are the same options that are passed [through controllers](../general/rendering.md#explicit-serializer).
### Looking up the Serializer for a Resource ### Looking up the Serializer for a Resource