https://github.com/ahx/jsonapi_schema
https://jsonapi.org/schema packed in a rubygem
https://github.com/ahx/jsonapi_schema
json-api jsonapi
Last synced: 10 months ago
JSON representation
https://jsonapi.org/schema packed in a rubygem
- Host: GitHub
- URL: https://github.com/ahx/jsonapi_schema
- Owner: ahx
- Created: 2019-03-21T09:05:01.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-29T16:55:50.000Z (almost 6 years ago)
- Last Synced: 2025-02-20T10:09:52.011Z (10 months ago)
- Topics: json-api, jsonapi
- Language: Ruby
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# JsonapiSchema
[](https://travis-ci.org/ahx/jsonapi_schema)
This is the [JSON:API JSON Schema](http://jsonapi.org/schema) packaged as a rubygem.
Use this to validate a HTTP response body according to [JSON:API](http://jsonapi.org).
## Installation
Add this line to your application's Gemfile:
```ruby
group :test, :development do
gem 'jsonapi_schema'
end
```
And then execute:
$ bundle
## Usage
```ruby
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](http://rubygems.org/gems/json_schemer) (not part of this gem):
```ruby
require 'json_schemer'
schemer = JSONSchemer.schema(JsonapiSchema.schema)
schemer.valid?(JSON.parse(last_response.body))
# => true/false
```
## Development
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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ahx/jsonapi_schema.