0.01
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Pagination helpers for Grape
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.3
>= 0
>= 0

Runtime

 Project Readme

Grape Pagination

Provides helpers for paginating collections in Grape endpoints. Currently only works with with will_paginate, or something that responds to the same paginate interface.

Installation

Add this line to your application's Gemfile:

gem 'grape-pagination'

Usage

Tag your endpoint as supporting pagination params, then use the paginate helper.

class API < Grape::API
  desc 'Gets everything!'
  paginate
  get do
    paginate collection
  end
end

Which would result in a paginated collection and the following headers set:

X-Total: 150
Link: <http://localhost:5000/api/v1/tweets?page=2&per_page=30>; rel="next"

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request