A convienient way to serialize errors in JsonAPI format (https://jsonapi.org)

Add this line to your application's Gemfile:

gem 'jsonapi_errors_handler'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jsonapi_errors_handler

In your controller:

include JsonapiErrorsHandler
rescue_from ::StandardError, with: lambda { |e| handle_error(e) }

From this point you'll have default html errors being serialized. JsonapiErrorsHandler offers 4 predefined errors:

• JsonapiErrorsHandler::Errors::Invalid
• JsonapiErrorsHandler::Errors::Forbidden
• JsonapiErrorsHandler::Errors::NotFound
• JsonapiErrorsHandler::Errors::Unauthorized

If you rise any of errors above in any place of your application, client gets the nicely formatted error message instead of 500

If you want your custom errors being handled by default, just add them to the mapper

include JsonapiErrorsHandler
ErrorsMapper.map_errors!({
    'ActiveRecord::RecordNotFound' => 'JsonapiErrorsHandler::Errors::NotFound',
    'ActiveRecord::RecordInvalid' => 'JsonapiErrorsHandler::Errors::Invalid',
})
rescue_from ::StandardError, with: lambda { |e| handle_error(e) }

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/driggl/jsonapi_errors_handler.

How to contribute:

1. Fork repository
2. Commit changes
   • Keep commits small and atomic
   • Start commit message from keywords (Add/Remove/Change/Refactor/Move/Rename/Upgrade/Downgrade)
   • Keep commits imperative style
3. Create Pull Request

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