JsonapiSchema

This is the JSON:API JSON Schema packaged as a rubygem. Use this to validate a HTTP response body according to JSON:API.

Add this line to your application's Gemfile:

group :test, :development do
  gem 'jsonapi_schema'
end

And then execute:

$ bundle

JsonapiSchema.schema_path # returns path to the schema file, a String

JsonapiSchema::MEDIA_TYPE # alias: JsonapiSchema::CONTENT_TYPE
# => 'application/vnd.api+json'

JsonapiSchema.schema # returns the parsed object, a Hash

Validate your response using json_schemer (not part of this gem):

require 'json_schemer'

schemer = JSONSchemer.schema(JsonapiSchema.schema)
schemer.valid?(JSON.parse(last_response.body))
# => true/false

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/ahx/jsonapi_schema.