Module: Respondo

Defined in:
lib/respondo.rb,
lib/respondo/railtie.rb,
lib/respondo/version.rb,
lib/respondo/serializer.rb,
lib/respondo/configuration.rb,
lib/respondo/response_builder.rb,
lib/respondo/controller_helpers.rb,
lib/generators/respondo/install/install_generator.rb

Overview

Respondo — Smart JSON API response formatter for Rails.

Examples:

Configure once in an initializer

# config/initializers/respondo.rb
Respondo.configure do |config|
  config.default_success_message = "OK"
  config.default_error_message   = "Something went wrong"
  config.include_request_id      = true
  config.camelize_keys           = true   # for Flutter/JS clients
end

Include manually (without Railtie / outside Rails)

class MyController
  include Respondo::ControllerHelpers
end

Defined Under Namespace

Modules: ControllerHelpers, Generators, Serializer Classes: Configuration, Railtie, ResponseBuilder

Constant Summary collapse

VERSION = 
"2.1.1"

Class Method Summary collapse

Class Method Details

.config ⇒ Respondo::Configuration

Returns:



28
29
30
 
# File 'lib/respondo.rb', line 28

def config
  @config ||= Configuration.new
end

.configure {|Respondo::Configuration| ... } ⇒ Object

Yields:



33
34
35
 
# File 'lib/respondo.rb', line 33

def configure
  yield config
end

.reset! ⇒ Object

Reset config (useful in tests)



38
39
40
 
# File 'lib/respondo.rb', line 38

def reset!
  @config = Configuration.new
end