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

Add document for for set_id method

Browse Source
This commit is contained in:
Shuhei Kitagawa 2018-03-18 15:24:15 +09:00 committed by Shishir Kakaraddi
parent a15232b47f
commit fa09c29190
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -78,6 +78,7 @@ end
class MovieSerializer
include FastJsonapi::ObjectSerializer
set_type :movie # optional
set_id :owner_id # optional
attributes :name, :year
has_many :actors
belongs_to :owner, record_type: :user
@ -114,7 +115,7 @@ json_string = MovieSerializer.new(movie).serialized_json
```json
{
"data": {
"id": "232",
"id": "3",
"type": "movie",
"attributes": {
"name": "test movie",
@ -238,6 +239,7 @@ end
Option | Purpose | Example
------------ | ------------- | -------------
set_type | Type name of Object | ```set_type :movie ```
set_id | ID of Object | ```set_id :owner_id ```
cache_options | Hash to enable caching and set cache length | ```cache_options enabled: true, cache_length: 12.hours```
id_method_name | Set custom method name to get ID of an object | ```has_many :locations, id_method_name: :place_ids ```
object_method_name | Set custom method name to get related objects | ```has_many :locations, object_method_name: :places ```