Module: PowerApi::GeneratorHelper::PaginationHelper

Extended by:
ActiveSupport::Concern
Included in:
PowerApi::GeneratorHelpers
Defined in:
lib/power_api/generator_helper/pagination_helper.rb

Instance Method Summary collapse

Instance Method Details

#api_pagination_initializer_path ⇒ Object 



8
9
10
 
# File 'lib/power_api/generator_helper/pagination_helper.rb', line 8

def api_pagination_initializer_path
  "config/initializers/api_pagination.rb"
end

#api_pagination_initializer_tpl ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/power_api/generator_helper/pagination_helper.rb', line 12

def api_pagination_initializer_tpl
  <<~API_PAGINATION
    ApiPagination.configure do |config|
      # If you have more than one gem included, you can choose a paginator.
      config.paginator = :kaminari

      # By default, this is set to 'Total'
      config.total_header = 'X-Total'

      # By default, this is set to 'Per-Page'
      config.per_page_header = 'X-Per-Page'

      # Optional: set this to add a header with the current page number.
      config.page_header = 'X-Page'

      # Optional: set this to add other response format. Useful with tools that define :jsonapi format
      # config.response_formats = [:json, :xml, :jsonapi]
      config.response_formats = [:jsonapi]

      # Optional: what parameter should be used to set the page option
      config.page_param do |params|
        params[:page][:number] if params[:page].is_a?(ActionController::Parameters)
      end

      # Optional: what parameter should be used to set the per page option
      config.per_page_param do |params|
        params[:page][:size] if params[:page].is_a?(ActionController::Parameters)
      end

      # Optional: Include the total and last_page link header
      # By default, this is set to true
      # Note: When using kaminari, this prevents the count call to the database
      config.include_total = true
    end
  API_PAGINATION
end