Powered by

# Jsonapi Extra

In 

Implements the JSON:API specifications for pagination.

When enabled, the query params used in the pagy URLs are nested under the page param, as specified by the Query Parameter Family e.g. https://example.com/products?page[number]=2&page[size]=30.

# Synopsis

# Default usage

pagy.rb (initializer)
require 'pagy/extras/jsonapi' # works without further configuration
Controller
# enabled by default
@pagy, @records = pagy(collection)
# you can disable it explicitly for specific requests
@pagy, @records = pagy(collection, jsonapi: false)

# Custom usage

pagy.rb (initializer)
# optionally require other extras useful with jsonapi
require 'pagy/extras/limit'
# jsonapi must be required AFTER other extras
require 'pagy/extras/jsonapi'
# optionally disable it by default (opt-in)
Pagy::DEFAULT[:jsonapi] = false               # default true
Controller
# disabled by default by the above Pagy::DEFAULT[:jsonapi] = false
@pagy, @records = pagy(collection)
# explicitly enable it for specific requests
@pagy, @records = pagy(collection, jsonapi: true)
# optional/custom setup
@pagy, @records = pagy(collection, jsonapi:      true,    # enable the jsonapi specifications
                                   limit_extra:  true,    # enable the limit extra
                                   page_param:   :number, # use page[number] param name instead of page[page]
                                   limit_params: :size)   # use page[size] param name instead of page[limit]
# get the links URL hash
links_hash = pagy_jsonapi_links(@pagy)
#=> {first: 'https://example.com/products?page[number]=1&page[size]=50&...',
#    last: 'https://example.com/products?page[number]=32&page[size]=50&...',
#    prev: 'https://example.com/products?page[number]=31&page[size]=50&...',
#    next: 'https://example.com/products?page[number]=33&page[size]=50&...'}

# Variables

Variable Description Default
:jsonapi Enable or disable the feature true

You can use the :jsonapi variable to opt-out of the feature even when the extra is required.

# Interaction with other features/extras

This extra just nests the :page and :limit params under the JSON:API reserved :page param. You may want to customize the :page_param and the :limit_param as shown in the Synopsis.

You may also want to use it with the limit extra in order to allow the client to request a specific number of items per page and capping it to a max number.

It works also with the countless, searchkick, elasticsearch_rails and meilisearch extras.

It does not make sense (and doesn't work) with the Calendar extra.

# Methods

The jsonapi extra adds the pagy_jsonapi_links helper to the Pagy::Backend module.

This helper provides the JSON:API links for pagination as a hash of first, last, prev, next paths. You can pass the option asbsolute: true to get an absolute URL instead.