Name: jsonapi-resources
Owner: DaWanda Engineering Team
Description: A resource-focused Rails library for developing JSON API compliant servers.
Forked from: cerebris/jsonapi-resources
Created: 2017-12-19 16:10:04.0
Updated: 2017-12-19 16:10:06.0
Pushed: 2018-01-09 12:58:09.0
Homepage: http://jsonapi-resources.com
Size: 2938
Language: Ruby
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
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.
Full documentation can be found at http://jsonapi-resources.com, including the v0.10 alpha Guide specific to this version.
We have a simple demo app, called Peeps, available to show how JR is used.
JSON:API maintains a (non-verified) listing of client libraries which should be compatible with JSON:API compliant server implementations such as JR.
Add JR to your application's Gemfile:
'jsonapi-resources'
And then execute:
le
Or install it yourself as:
install jsonapi-resources
For further usage see the v0.10 alpha Guide
git checkout -b my-new-feature)rake test)git commit -am 'Add some feature')git push origin my-new-feature)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 or attach as a file:
Copyright 2014-2017 Cerebris Corporation. MIT License (see LICENSE for details).