mirror of https://github.com/hashicorp/jsonapi-resources synced 2026-04-05 18:41:53 +00:00

No description

Ruby 100%

Find a file

Larry Gebhardt 7ebba9b096 Apply default sort to related_resource requests (cherry picked from commit `600a818`)		2017-02-24 09:43:19 -05:00
lib	Apply default sort to related_resource requests	2017-02-24 09:43:19 -05:00
locales	Refactor for operations support	2017-01-05 09:08:20 -05:00
test	Apply default sort to related_resource requests	2017-02-24 09:43:19 -05:00
.gitignore	Add configuration option to whitelist all exceptions.	2016-10-25 11:03:22 -07:00
.travis.yml	Updates Travis to use latest stable ruby versions	2017-01-13 09:08:14 -05:00
Gemfile	Remove rails as dependency	2016-10-04 13:23:21 -04:00
jsonapi-resources.gemspec	Remove rails as dependency	2016-10-04 13:23:21 -04:00
LICENSE.txt	Initial commit	2014-03-29 14:47:11 -04:00
Rakefile	Thread-safe formatter caching, added simple benchmark	2016-04-29 10:19:25 -04:00
README.md	add bug report templates	2017-02-15 21:13:57 +02:00

README.md

JSONAPI::Resources

JSONAPI::Resources, or "JR", provides a framework for developing an API server that complies with the JSON:API specification.

Like JSON:API itself, JR's design is focused on the resources served by an API. JR needs little more than a definition of your resources, including their attributes and relationships, to make your server compliant with JSON API.

JR is designed to work with Rails 4.2+, and provides custom routes, controllers, and serializers. JR's resources may be backed by ActiveRecord models or by custom objects.

Documentation

Full documentation can be found at http://jsonapi-resources.com, including the v0.10 alpha Guide specific to this version.

Demo App

We have a simple demo app, called Peeps, available to show how JR is used.

Client Libraries

JSON:API maintains a (non-verified) listing of client libraries which should be compatible with JSON:API compliant server implementations such as JR.

Installation

Add JR to your application's Gemfile:

gem 'jsonapi-resources'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jsonapi-resources

For further usage see the v0.10 alpha Guide

Contributing

Fork it ( http://github.com/cerebris/jsonapi-resources/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

Did you find a bug?

Ensure the bug was not already reported by searching on GitHub under Issues.
If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
If possible, use the relevant bug report templates to create the issue. Simply copy the content of the appropriate template into a .rb file, make the necessary changes to demonstrate the issue, and paste the content into the issue description:
- Rails 5 issues