Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jsonapi-rb/jsonapi-renderer
Efficiently render JSON API documents.
https://github.com/jsonapi-rb/jsonapi-renderer
api json json-api jsonapi jsonapi-rb serialization
Last synced: about 3 hours ago
JSON representation
Efficiently render JSON API documents.
- Host: GitHub
- URL: https://github.com/jsonapi-rb/jsonapi-renderer
- Owner: jsonapi-rb
- License: mit
- Created: 2016-10-26T01:47:48.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-08-31T15:08:03.000Z (over 1 year ago)
- Last Synced: 2024-12-13T16:57:48.399Z (12 days ago)
- Topics: api, json, json-api, jsonapi, jsonapi-rb, serialization
- Language: Ruby
- Homepage: http://jsonapi-rb.org
- Size: 47.9 KB
- Stars: 28
- Watchers: 6
- Forks: 12
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jsonapi-renderer
Ruby gem for rendering [JSON API](http://jsonapi.org) documents.
## Status
[](https://badge.fury.io/rb/jsonapi-renderer)
[](http://travis-ci.org/jsonapi-rb/renderer?branch=master)
[](https://codecov.io/gh/jsonapi-rb/renderer)
[](https://gitter.im/jsonapi-rb/Lobby)
## Resources
* Chat: [gitter](http://gitter.im/jsonapi-rb)
* Twitter: [@jsonapirb](http://twitter.com/jsonapirb)
* Docs: [jsonapi-rb.org](http://jsonapi-rb.org)
## Installation
```ruby
# In Gemfile
gem 'jsonapi-renderer'
```
then
```
$ bundle
```
or manually via
```
$ gem install jsonapi-renderer
```
## Usage
First, require the gem:
```ruby
require 'jsonapi/renderer'
```
### Rendering resources
A resource here is any class that implements the following interface:
```ruby
class ResourceInterface
# Returns the type of the resource.
# @return [String]
def jsonapi_type; end
# Returns the id of the resource.
# @return [String]
def jsonapi_id; end
# Returns a hash containing, for each included relationship, an array of the
# resources to be included from that one.
# @param included_relationships [Array] The keys of the relationships
# to be included.
# @return [Hash{Symbol => Array<#ResourceInterface>}]
def jsonapi_related(included_relationships); end
# Returns a JSON API-compliant representation of the resource as a hash.
# @param options [Hash]
# @option fields [Set, Nil] The requested fields, or nil.
# @option include [Set] The requested relationships to
# include (defaults to []).
# @return [Hash]
def as_jsonapi(options = {}); end
end
```
#### Rendering a single resource
```ruby
JSONAPI.render(data: resource,
include: include_string,
fields: fields_hash,
meta: meta_hash,
links: links_hash)
```
This returns a JSON API compliant hash representing the described document.
#### Rendering a collection of resources
```ruby
JSONAPI.render(data: resources,
include: include_string,
fields: fields_hash,
meta: meta_hash,
links: links_hash)
```
This returns a JSON API compliant hash representing the described document.
#### Rendering a relationship
```ruby
JSONAPI.render(data: resource,
relationship: :posts,
include: include_string,
fields: fields_hash,
meta: meta_hash,
links: links_hash)
```
This returns a JSON API compliant hash representing the described document.
### Rendering errors
```ruby
JSONAPI.render_errors(errors: errors,
meta: meta_hash,
links: links_hash)
```
where `errors` is an array of objects implementing the `as_jsonapi` method, that
returns a JSON API-compliant representation of the error.
This returns a JSON API compliant hash representing the described document.
### Caching
The generated JSON fragments can be cached in any cache implementation
supporting the `fetch_multi` method.
When using caching, the serializable resources must implement an
additional `jsonapi_cache_key` method:
```ruby
# Returns a cache key for the resource, parameterized by the `include` and
# `fields` options.
# @param options [Hash]
# @option fields [Set, Nil] The requested fields, or nil.
# @option include [Set] The requested relationships to
# include (defaults to []).
# @return [String]
def jsonapi_cache_key(options = {}); end
```
The cache instance must be passed to the renderer as follows:
```ruby
JSONAPI.render(data: resources,
include: include_string,
fields: fields_hash,
cache: cache_instance)
```
## License
jsonapi-renderer is released under the [MIT License](http://www.opensource.org/licenses/MIT).