Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/4xposed/grape-sideload
Add support for sideload JSON in your Grape API
https://github.com/4xposed/grape-sideload
grape grape-api ruby sideload
Last synced: about 2 months ago
JSON representation
Add support for sideload JSON in your Grape API
- Host: GitHub
- URL: https://github.com/4xposed/grape-sideload
- Owner: 4xposed
- License: mit
- Created: 2016-12-18T19:18:26.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-01T15:09:23.000Z (over 6 years ago)
- Last Synced: 2024-10-04T13:34:53.234Z (3 months ago)
- Topics: grape, grape-api, ruby, sideload
- Language: Ruby
- Size: 12.7 KB
- Stars: 18
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Grape::Sideload
[](https://badge.fury.io/rb/grape-sideload)
[](https://travis-ci.org/4xposed/grape-sideload)
[](https://gemnasium.com/github.com/4xposed/grape-sideload)
[](https://codeclimate.com/github/4xposed/grape-sideload)
Add JSON sideloading support to your Grape API so you can deliver multiple resources under one endpoint.
## Table of Contents
- [What is Grape?](#what-is-grape)
- [What is Sideloading JSON?](#what-is-sideloading-json)
- [Why do I need this gem?](#why-do-i-need-this-gem)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## What is Grape?
Grape is a ruby framework for creating APIs
[grape](https://github.com/ruby-grape/grape)
## What is Sideloading JSON?
Sideloading allows you to deliver related records as part of a single request.
For example, normally a request to `/tickets.json` returns ticket resources with a structure similar to:
```
{
"tickets": [
{
"requester_id": 7,
...
},
...
]
}
```
To fetch the requester's data, your consumer then needs to make another request to `/users/7.json`.
Using sideloading, you can deliver a the user resource along with the ticket in a single request.
The response will include a top-level array of associated data under the appropriate resource key.
```
{
"tickets": [
{
"requester_id": 7,
...
},
...
],
"users": [
{
"id": 7,
"name": "Bob Bobberson",
...
}
]
}
```
## Why do I need this gem?
The Grape framework doesn't offer support for sideloading the resources you deliver with your API's
response, this gem will help you doing exactly that in a simple manner.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'grape-sideload'
```
then execute:
$ bundle
And add to your `app.rb`
```ruby
require 'grape-sideload'
```
## Usage
example for sideloading with `present_many`:
```ruby
resources :tickets do
get do
present_many({ present: current_user.tickets, with: Ticket::Entity },
{ present: current_user, with: User::Entity})
end
end
```
example for sideloading with `merge_payloads` to sideload using grape's present syntax:
```ruby
resource :tickets do
get do
merge_payloads(present(current_user.tickets, with: Ticket::Entity),
present(current_user, with: User::Entity))
end
end
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/4xposed/grape-sideload. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).