sharpetronics/jsonapi-serializer
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add README instructions for using sparse fieldsets

Browse Source
This commit is contained in:
Erol 2018-07-17 12:02:58 +08:00 committed by Shishir Kakaraddi
parent fa194133fa
commit 9aec7c58ed
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -32,6 +32,7 @@ Fast JSON API serialized 250 records in 3.01 ms
* [Params](#params) * [Params](#params)
* [Conditional Attributes](#conditional-attributes) * [Conditional Attributes](#conditional-attributes)
* [Conditional Relationships](#conditional-relationships) * [Conditional Relationships](#conditional-relationships)
* [Sparse Fieldsets](#sparse-fieldsets)
* [Contributing](#contributing) * [Contributing](#contributing)
@ -388,6 +389,21 @@ serializer = MovieSerializer.new(movie, { params: { admin: current_user.admin? }
serializer.serializable_hash serializer.serializable_hash
``` ```
### Sparse Fieldsets
Attributes and relationships can be selectively returned per record type by using the `fields` option.
```ruby
class MovieSerializer
include FastJsonapi::ObjectSerializer
attributes :name, :year
end
serializer = MovieSerializer.new(movie, { fields: { movie: [:name] } })
serializer.serializable_hash
```
### Customizable Options ### Customizable Options
Option | Purpose | Example Option | Purpose | Example