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

Updated README

Browse Source
This commit is contained in:
Brusk Awat 2023-02-13 23:25:23 +03:00
parent 887c506fd2
commit 726d6828db
Signed by: broosk1993
GPG Key ID: 5D20F7E02649F74E
1 changed files with 51 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -2,6 +2,57 @@
Ruby gem for deserializing [JSON API](http://jsonapi.org) payloads into custom
hashes.
## Usage
#### Support for included documents
To insert the included documents to ``has_one`` and ``has_many`` relation ship, use the ``with_included: true`` option to the relationship:
```ruby
class DeserializableBook < JSONAPI::Deserializable::Resource
id
type
attributes :id,
:title
has_one :author, with_included: true
end
```
To use a custom deserializer for the included relationship, use the ``deserializer`` option:
```ruby
class DeserializableBook < JSONAPI::Deserializable::Resource
id
type
attributes :id,
:title
has_one :author, with_included: true, deserializer: DeserialzableAuthor
end
```
If the property name is different than the included object type, pass the ``type`` option:
```ruby
class DeserializableBook < JSONAPI::Deserializable::Resource
id
type
attributes :id,
:title
has_one :author, with_included: true, deserializer: DeserializablePerson, type: 'people'
end
```
## Status
[![Gem Version](https://badge.fury.io/rb/jsonapi-deserializable.svg)](https://badge.fury.io/rb/jsonapi-deserializable)