No commit activity in last 3 years
No release in over 3 years
The gem for rails framework to modify the api response
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.13
~> 10.0
 Project Readme

RailsApiResponse

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/rails_api_response. To experiment with that code, run bin/console for an interactive prompt.

Installation

Add this line to your application's Gemfile:

gem 'rails_api_response'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rails_api_response

Usage

Add the line include RailsApiResponse::ControllerHelpers::Responses to the controller where you want to you response format. (Recommended: base or application controller).

Response success: respond_success message: "Create user successfully", data: {}.

Response error: respond_error message: "Create user failed", data: {} or respond_error instance: @user, data: {} (with instance param, the format will be got from errors and full message from instance.

Response with customer code: respond_json code: 200, message: "", data: {}.

The last format will be always { code: 200, metadata: { message: '' }, data: {} }

Development

After checking out the repo, run bin/setup to install dependencies. 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 on GitHub at https://github.com/[USERNAME]/rails_api_response.

api-response