ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-22 22:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
2c2f948fa0
active_model_serializers/docs/howto/add_pagination_links.md
Bruno Bacarini 2c2f948fa0 Add pagination links automatically 
Pagination links will be included in your response automatically as long
as the resource is paginated using Kaminari or WillPaginate
and if you are using a JSON-API adapter. The others adapters does not have this feature.
2015-08-18 19:04:04 -03:00

1.5 KiB
Raw Blame History

How to add pagination links

Pagination links will be included in your response automatically as long as the resource is paginated and if you are using a JSON-API adapter. The others adapters does not have this feature.

If you want pagination links in your response, use Kaminari or WillPaginate.

#kaminari example
@posts = Kaminari.paginate_array(Post.all).page(3).per(1)
render json: @posts

#will_paginate example
@posts = Post.all.paginate(page: 3, per_page: 1)
render json: @posts

ActiveModel::Serializer.config.adapter = :json_api

ex:

{
  "data": [
    {
      "type": "articles",
      "id": "3",
      "attributes": {
        "title": "JSON API paints my bikeshed!",
        "body": "The shortest article. Ever.",
        "created": "2015-05-22T14:56:29.000Z",
        "updated": "2015-05-22T14:56:28.000Z"
      }
    }
  ],
  "links": {
    "self": "http://example.com/articles?page[number]=3&page[size]=1",
    "first": "http://example.com/articles?page[number]=1&page[size]=1",
    "prev": "http://example.com/articles?page[number]=2&page[size]=1",
    "next": "http://example.com/articles?page[number]=4&page[size]=1",
    "last": "http://example.com/articles?page[number]=13&page[size]=1"
  }
}

AMS relies on either Kaminari or WillPaginate. Please install either dependency by adding one of those to your Gemfile.