Module: JSONAPI

Defined in:

lib/jsonapi/renderer.rb,
lib/jsonapi/include_directive.rb,
lib/jsonapi/renderer/document.rb,
lib/jsonapi/include_directive/parser.rb,
lib/jsonapi/renderer/resources_processor.rb

Defined Under Namespace

Modules: Renderer Classes: IncludeDirective

Class Method Summary

• .render(params) ⇒ Object

  Render a JSON API document.

Class Method Details

.render(params) ⇒ Object

Render a JSON API document.

Parameters:

• params (Hash) —

  @option [(#jsonapi_id, #jsonapi_type, #jsonapi_related, #as_jsonapi),

  Array<(#jsonapi_id, #jsonapi_type, #jsonapi_related,
  #as_jsonapi)>,
  nil] data Primary resource(s) to be rendered.
  

  @option [Array<#jsonapi_id>] errors Errors to be rendered. @option include Relationships to be included. See

  JSONAPI::IncludeDirective.
  

  @option [HashArray<Symbol>, HashArray<String>] fields

  List of requested fields for some or all of the resource types.
  

  @option [Hash] meta Non-standard top-level meta information to be

  included.
  

  @option [Hash] links Top-level links to be included. @option [Hash] jsonapi_object JSON API object.

# File 'lib/jsonapi/renderer.rb', line 22

def render(params)
  Renderer::Document.new(params).to_hash
end