Module: RESTFramework::ListModelMixin

Included in:
ModelControllerMixin, ReadOnlyModelControllerMixin
Defined in:
lib/rest_framework/controller_mixins/models.rb

Overview

Mixin for listing records.

Instance Method Summary collapse

Instance Method Details

#index ⇒ Object 



229
230
231
 
# File 'lib/rest_framework/controller_mixins/models.rb', line 229

def index
  api_response(self.index!)
end

#index! ⇒ Object 



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/rest_framework/controller_mixins/models.rb', line 233

def index!
  @records ||= self.get_filtered_data(self.get_recordset)

  # Handle pagination, if enabled.
  if self.class.paginator_class
    paginator = self.class.paginator_class.new(data: @records, controller: self)
    page = paginator.get_page
    serialized_page = self.serialize(page)
    return paginator.get_paginated_response(serialized_page)
  else
    return self.serialize(@records)
  end
end