Render JSON response in a unified format
MIT License
Render JSON response in a unified format
Add this line to your application's Gemfile:
gem 'out_put'
And then execute:
$ bundle
initializers: out_put.rb
OutPut::Config.tap do |config|
config.project_code = 101000 # MUST padding three zero here
config.pagination_for = :list
end
project_code
(defaults to 0) + code
will be the final code
Add this line in your (base) controller:
include OutPut
To render a json response, call output
method, it's very easy:
output 0, 'success'
# the same as above:
output code: 0, msg: 'success'
# will render by the default format:
# {
# result: { code: 0, message: 'success' }
# }
ok # => code: 0, message: 'success'
data
filedoutput 0, foo: 'bar', list: [ 1, 2, 3 ]
# will render by the default format:
# {
# result: { code: 0, message: '' }
# data: { foo: 'bar', list: [1,2,3] }
# }
# or
ok_with foo: 'bar'
output 0, 'success', http: 200
You don't need to pass your project code like '101', after config:
error 700, 'the 7th api error 0' # => the final code will be 101700
# or
error_with 700, 'msg', foo: 'bar'
error
is an alias of output
output
any objects which have implemented serialization method info
BusinessError.record_not_found.info # => { code: ..., msg: ... }
output BusinessError.record_not_found
output only: { foo: 'bar' }
# will render: { foo: 'bar' }
# response an array
output only: [ 1, 2, 3 ]
output cache: 24.hours do
{ list: User.all }
end # will render: { list: [...] }
output foo: 'bar', cache: 24.hours do
{ list: User.all }
end # will render: { foo: 'bar', list: [...] }
output only: { foo: 'bar' }, cache: 24.hours do
{ only: { list: User.all } }
end # will ONLY render: { foo: 'bar', list: [...] }
Note: the cache key will be "output/#{action_name}"
total
:if config.pagination_for = :list
:
output 0, list: [ 1, 2, 3 ]
# will render:
# {
# result: { code: 0, message: '' }
# data: { total: 3, list: [1,2,3] }
# }
build_with
to pass an variable @view
to your viewbuild_with key: 'val'
build_with code=0, msg='success', key: 'val'
# the in your .jbuilder
json.result do
json.code @view[:code] || 0
json.msg @view[:msg] || 'success'
end
json.data do
json.merge! @view.data # => expect code and msg, for example { key: 'val' }
# or
json.key @view[:key]
end