https://github.com/lawitschka/rails-api-validation-errors

Untranslated validation errors with all meta data for APIs behind Javascript frontends
https://github.com/lawitschka/rails-api-validation-errors

Last synced: about 2 months ago
JSON representation

Untranslated validation errors with all meta data for APIs behind Javascript frontends

• Host: GitHub
• URL: https://github.com/lawitschka/rails-api-validation-errors
• Owner: lawitschka
• License: mit
• Created: 2014-03-13T09:53:35.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2019-05-08T07:04:12.000Z (over 5 years ago)
• Last Synced: 2024-09-16T23:55:09.043Z (4 months ago)
• Language: Ruby
• Size: 313 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
[![Gem Version](http://img.shields.io/gem/v/rails_api_validation_errors.svg)](https://rubygems.org/gems/rails_api_validation_errors)

[![Build Status](http://img.shields.io/travis/lawitschka/rails-api-validation-errors.svg)](https://travis-ci.org/lawitschka/rails-api-validation-errors)

[![Coverage Status](http://img.shields.io/coveralls/lawitschka/rails-api-validation-errors.svg)](https://coveralls.io/r/lawitschka/rails-api-validation-errors)

[![Code Climate](http://img.shields.io/codeclimate/github/lawitschka/rails-api-validation-errors.svg)](https://codeclimate.com/github/lawitschka/rails-api-validation-errors)

# Rails API validation errors

Untranslated validation errors with all meta data for APIs behind Javascript frontends

## Installing

The easiest way to install `Rails::API::ValidationErrors` is to add it to your

`Gemfile`:

```ruby

gem "rails_api_validation_errors"

```

Then, install it on the command line:

```

$ bundle install

```

## Usage

Include `Rails::API::HashValidationErrors` in your API's base controller. This makes

sure that Rails will not translate error messages, but returns a hash per attribute

and error including the error key and meta information.

```ruby

class API::BaseController < ApplicationController

  include Rails::API::HashValidationErrors

end

```

To use the new error messages simply return the model's errors in JSON or XML

in your controllers:

```ruby

class API::PeopleController < API::BaseController

  def create

    @person = Person.new(person_params)

    if @person.valid?

      render :json => @person

    else

      render :json => { :errors => @person.errors }

    end

  end

end

```

This will result in the following JSON response in case of validation errors:

```json

{

  "errors": {

    "name": [

      {

        "message": "blank",

        "meta":{}

      }

    ]

  }

}

```