This repository has been archived by the owner. It is now read-only.
Validate JSON in your specs using JSON schema.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
Gemfile
LICENSING.md
README.md
Rakefile
circle.yml
rspec_json_schema_matcher.gemspec

README.md

RSpec JSON schema matcher

Build status

Validate JSON in your specs using JSON schema:

it "returns a valid user resource" do
  expect(response.body).to match_schema "user"
end

Handy for testing JSON-based web APIs!

Installation

Add this to your application's Gemfile:

group :test do
  gem "rspec_json_schema_matcher"
end

Then install the gem:

$ bundle

Usage

You might want to read my blog post.

Provides a single RSpec matcher called match_schema that accepts a relative path to a JSON schema without the .json extension.

The matcher assumes that your schemas are stored in ./spec/support/schemas or in its subdirectories.

For example, if you want to use ./spec/support/schemas/users/instance.json, write match_schema "users/instance".

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec 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.

Contributing

Bug reports and pull requests are welcome!

Licence

The gem is available as open source under the terms of the ISC License.