README.md

JsonapiCompliable

JSONAPI Suite Website

Documentation

Supported Rails versions: >= 4.1

Upgrading to 0.11.x

Due to a backwards-incompatibility introduced in the underlying jsonapi-rb gem, specifying custom serializers now works slightly differently.

Before:

# app/serializers/serializable_post.rb

has_many :comments, class: SerializableSpecialComment

and/or

render_jsonapi(post, class: SerializableSpecialPost)

This is now all handled at the controller level:

render_jsonapi(post, class: {
  Post: SerializableSpecialPost,
  Comment: SerializableSpecialComment
})

Upgrading to 0.10

sideload_whitelist has been moved from the resource to the controller:

class PostsController < ApplicationController
  jsonapi resource: PostResource do
-    sideload_whitelist({ index: [:foo] })
-  end
+  sideload_whitelist({ index: [:foo] })
end

# NEW

Running tests

We support Rails >= 4.1. To do so, we use the appraisal gem. So, run:

$ bin/appraisal rails-4 bin/rspec
$ bin/appraisal rails-5 bin/rspec

Or run tests for all versions:

$ bin/appraisal bin/rspec

Generating the Documentation

$ yard doc
$ yard server