GitHub - bliof/jsonapi-resources: A resource-focused Rails library for developing JSON:API compliant servers.

JSONAPI::Resources, or "JR", provides a high-performance framework for serving read-only JSON:API compliant responses in Rails 8.0+ applications.

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 8.0+, and provides custom routes, controllers, and serializers. JR's resources may be backed by ActiveRecord models or by custom objects.

Note: This version of JR is read-only. Mutation operations (create, update, destroy) have been removed to streamline the library for high-scale reading purposes.

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:

And then execute:

Or install it yourself as:

gem install jsonapi-resources

For further usage see the v0.10 alpha Guide

Contributing

Submit an issue describing any new features you wish it add or the bug you intend to fix
Fork it ( http://github.com/cerebris/jsonapi-resources/fork )
Create your feature branch (git checkout -b my-new-feature)
Run the full test suite (rake test)
Fix any failing tests
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?