Method: Blueprinter::Base.render

Defined in:

lib/blueprinter/base.rb

.render(object, options = {}) ⇒ String

Generates a JSON formatted String. Takes a required object and an optional view.

Examples:

Generating JSON with an extended view

post = Post.all
Blueprinter::Base.render post, view: :extended
# => "[{\"id\":1,\"title\":\"Hello\"},{\"id\":2,\"title\":\"My Day\"}]"

Parameters:

• object (Object) —

  the Object to serialize upon.

• options (Hash) (defaults to: {}) —

  the options hash which requires a :view. Any additional key value pairs will be exposed during serialization.

Options Hash (options):

• :view (Symbol) —

  Defaults to :default. The view name that corresponds to the group of fields to be serialized.

• :root (Symbol|String) —

  Defaults to nil. Render the json/hash with a root key if provided.

• :meta (Any) —

  Defaults to nil. Render the json/hash with a meta attribute with provided value if both root and meta keys are provided in the options hash.

Returns:

• (String) —

  JSON formatted String

# File 'lib/blueprinter/base.rb', line 195

def self.render(object, options = {})
  jsonify(prepare_for_render(object, options))
end