Giter VIP home page Giter VIP logo

error_responder's Introduction

Gem Version

Error responder for Rails API

Generator of standard HTTP responses and error serializer for models.

Getting Started

Add it to your Gemfile:

gem 'error_responder'

1) Generate standard HTTP responses

err_respond(err_code, key: nil, message: nil)

2) Generate responce with model validation errors

serialize_errors(errors, options = {})

Usage example

1) Generate standard HTTP responses

err_respond 404

Will be generated:

{
    "status": "404",
    "info": "Not Found",
    "errors": {}
}

You can pass a custom error message:

err_respond 404, key: 'user', message: 'Not present in database.'

Will be generated:

{
    "status": "404",
    "info": "Not Found",
    "errors": {
        "user": "Not present in database."
    }
}

2) Generate responce with model validation errors

@user = User.new(user_params)
if @user.save
  # ...
else
  serialize_errors(@user.errors)
end

Will be generated (model errors):

{
    "status": 409,
    "info": "Conflict",
    "errors": {
        "username": "Username can't be blank.",
        "first_name": "First name can't be blank.",
        "last_name": "Last name can't be blank."
    }
}

License

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

error_responder's People

Contributors

vadimstroganov avatar

Watchers

James Cloos avatar Daniel avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.