API Pagination Standards -

i have been working on api , pagination required. 25 elements returned in each request. looking around standards , seem see 2 different things going on.

1. the link header
   • link: http://tools.ietf.org/html/rfc5988

example:

link: <https://api.github.com/user/repos?page=3&per_page=100>; rel="next",   <https://api.github.com/user/repos?page=50&per_page=100>; rel="last" 

---

2. in json response
   • link: api pagination best practices

example:

"paging":  {     "previous":  "http://api.example.com/foo?since=timestamp"     "next":  "http://api.example.com/foo?since=timestamp2" } 

question:

should both? , being said; key "paging" correct key? or "links" or "pagination"

i depends on structure of data return (and may return in future).

if never have nested objects need own links, using link header (mildly) preferable, because it's more correct. issue nested objects can't nest link headers.

consider following collection entity:

{     "links": {         "collection": "/cards?offset=0&limit=25"     },     "data": [         {             "cardname": "island of wak-wak",             "type": "land",             "links": {                 "set": "/cards?set=arabian knights"             }         },         {             "cardname": "mana drain",             "type": "interrupt",             "links": {                 "set": "/cards?set=legends"             }         }     ] } 

there's no way include links cards in headers.