davidcelisdavidcelis
688

Api Pagination

screenshot of Api Pagination
rails

:page_facing_up: Link header pagination for Rails and Grape APIs.

Github

Overview

Navigating through paginated data can often be challenging, especially when trying to maintain a clean and efficient API response. The api-pagination gem brings a refreshing approach by allowing pagination to be integrated into response headers rather than cluttering the response body. This implementation adheres to the proposed RFC-8288 standard for Web linking, ensuring a standardized approach across various applications. Whether you're utilizing frameworks like Pagy, Kaminari, or WillPaginate, this gem streamlines the process while providing flexibility and control in how data is presented.

With api-pagination, developers can efficiently manage how their data is paginated and served to clients. It offers an array of features that enhance the configuration options, allowing for the customization necessary to fit your application’s needs. This enables a smoother user experience and better data handling practices.

Features

  • Header-based Pagination: Leverages HTTP headers to provide pagination information, keeping the response body clean and focused on data.
  • Framework Compatibility: Automatically detects and supports popular pagination libraries - Pagy, Kaminari, or WillPaginate.
  • Configurable Options: Allows developers to set specific configuration options including maximum items per page for improved control over data requests.
  • Seamless Integration: Easily integrates into existing Rails applications with minimal changes to the existing controller structure.
  • Direct Collection Paging: Offers the ability to paginate collections directly, giving full control over how paginated data is rendered.
  • Compatibility with ActiveModel: Works seamlessly with ActiveModel::Serializers for efficient serialization of paginated data.
  • Robust Header Management: Automatically generates the necessary Link headers to support pagination, enhancing navigation through data sets.
  • Support for Grape Framework: Provides an easy way to integrate pagination when using the Grape API framework, enhancing usability for API developers.
rails
Ruby on Rails

Ruby on Rails, often referred to as Rails, is an open-source web application framework written in Ruby. Known for its convention over configuration and don't repeat yourself (DRY) principles, Rails simplifies and accelerates the development of database-backed web applications.