JSON: structure for paged results / result pagination

rich1.0phorkiehttps://p.cweiske.de/JSON: structure for paged results / result paginationChristian Weiske86400900900 <link rel="stylesheet" href="https://p.cweiske.de/css/embed.css"/> <div class="phork" id="322"> <div class="phork-file"> <div class="phork-content"> <div class="document"> <ul class="simple"> <li><a class="reference external" href="https://developers.facebook.com/docs/graph-api/using-graph-api#paging">https://developers.facebook.com/docs/graph-api/using-graph-api#paging</a></li> <li><a class="reference external" href="http://fractal.thephpleague.com/pagination/">http://fractal.thephpleague.com/pagination/</a></li> <li><a class="reference external" href="https://google.github.io/styleguide/jsoncstyleguide.xml#Paging_Example">https://google.github.io/styleguide/jsoncstyleguide.xml#Paging_Example</a></li> <li><a class="reference external" href="https://laravel.com/docs/5.1/pagination">https://laravel.com/docs/5.1/pagination</a></li> <li><a class="reference external" href="https://developer.github.com/v3/#pagination">https://developer.github.com/v3/#pagination</a></li> <li><a class="reference external" href="http://stackoverflow.com/questions/12168624/pagination-response-payload-from-a-restful-api">http://stackoverflow.com/questions/12168624/pagination-response-payload-from-a-restful-api</a></li> <li><a class="reference external" href="https://dev.twitter.com/overview/api/cursoring">https://dev.twitter.com/overview/api/cursoring</a></li> <li><a class="reference external" href="http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api#pagination">http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api#pagination</a></li> <li><a class="reference external" href="https://tools.ietf.org/html/rfc5988#page-6">https://tools.ietf.org/html/rfc5988#page-6</a></li> <li><a class="reference external" href="http://jsonapi.org/format/#fetching-pagination">http://jsonapi.org/format/#fetching-pagination</a></li> </ul> </div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/322/rev-raw/6cbda0bc6026f454542da1376d6cc1b601c4bb9d/0-links.rst" style="float: right">view raw source</a> <a href="https://p.cweiske.de/322#0-links.rst">0-links.rst</a> </div> </div> <div class="phork-file"> <div class="phork-content"> <style type="text/css">/** * GeSHi (C) 2004 - 2007 Nigel McNie, 2007 - 2008 Benny Baumann * (http://qbnz.com/highlighter/ and http://geshi.org/) */ .javascript .de1, .javascript .de2 {font: normal normal 1em/1.2em monospace; margin:0; padding:0; background:none; vertical-align:top;} .javascript {font-family:monospace;} .javascript .imp {font-weight: bold; color: red;} .javascript li, .javascript .li1 {color: #DDD;} .javascript .ln {width:1px;text-align:right;margin:0;padding:0 2px;vertical-align:top;} .javascript .kw1 {color: #000066; font-weight: bold;} .javascript .kw2 {color: #003366; font-weight: bold;} .javascript .kw3 {color: #000066;} .javascript .co1 {color: #006600; font-style: italic;} .javascript .co2 {color: #009966; font-style: italic;} .javascript .coMULTI {color: #006600; font-style: italic;} .javascript .es0 {color: #000099; font-weight: bold;} .javascript .br0 {color: #009900;} .javascript .sy0 {color: #339933;} .javascript .st0 {color: #3366CC;} .javascript .nu0 {color: #CC0000;} .javascript .me1 {color: #660066;} .javascript span.xtra { display:block; } </style><div class="code"><table class="javascript"><tbody><tr class="li1"><td class="ln"><pre class="de1">1 2 3 4 5 6 7 8 9 10 11 12 13 </pre></td><td class="de1"><pre class="de1">{   "data": [      "... Endpoint data is here"   ],   "paging": {     "cursors": {       "after": "MTAxNTExOTQ1MjAwNzI5NDE=",       "before": "NDMyNzQyODI3OTQw"     },     "previous": "https://graph.facebook.com/me/albums?limit=25&amp;before=NDMyNzQyODI3OTQw"     "next": "https://graph.facebook.com/me/albums?limit=25&amp;after=MTAxNTExOTQ1MjAwNzI5NDE="   } }</pre></td></tr></tbody></table></div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/322/rev-raw/6cbda0bc6026f454542da1376d6cc1b601c4bb9d/facebook-cursor.json" style="float: right">view raw source</a> <a href="https://p.cweiske.de/322#facebook-cursor.json">facebook-cursor.json</a> </div> </div> <div class="phork-file"> <div class="phork-content"> <div class="code"><pre class="txt">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" </pre></div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/322/rev-raw/6cbda0bc6026f454542da1376d6cc1b601c4bb9d/github.httpheaders.txt" style="float: right">view raw source</a> <a href="https://p.cweiske.de/322#github.httpheaders.txt">github.httpheaders.txt</a> </div> </div> <div class="phork-file"> <div class="phork-content"> <style type="text/css">/** * GeSHi (C) 2004 - 2007 Nigel McNie, 2007 - 2008 Benny Baumann * (http://qbnz.com/highlighter/ and http://geshi.org/) */ .javascript .de1, .javascript .de2 {font: normal normal 1em/1.2em monospace; margin:0; padding:0; background:none; vertical-align:top;} .javascript {font-family:monospace;} .javascript .imp {font-weight: bold; color: red;} .javascript li, .javascript .li1 {color: #DDD;} .javascript .ln {width:1px;text-align:right;margin:0;padding:0 2px;vertical-align:top;} .javascript .kw1 {color: #000066; font-weight: bold;} .javascript .kw2 {color: #003366; font-weight: bold;} .javascript .kw3 {color: #000066;} .javascript .co1 {color: #006600; font-style: italic;} .javascript .co2 {color: #009966; font-style: italic;} .javascript .coMULTI {color: #006600; font-style: italic;} .javascript .es0 {color: #000099; font-weight: bold;} .javascript .br0 {color: #009900;} .javascript .sy0 {color: #339933;} .javascript .st0 {color: #3366CC;} .javascript .nu0 {color: #CC0000;} .javascript .me1 {color: #660066;} .javascript span.xtra { display:block; } </style><div class="code"><table class="javascript"><tbody><tr class="li1"><td class="ln"><pre class="de1">1 2 3 4 5 </pre></td><td class="de1"><pre class="de1">{   "total_count": 1232,   "incomplete_results": false,   "items": [] }</pre></td></tr></tbody></table></div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/322/rev-raw/6cbda0bc6026f454542da1376d6cc1b601c4bb9d/github.json" style="float: right">view raw source</a> <a href="https://p.cweiske.de/322#github.json">github.json</a> </div> </div> <div class="phork-file"> <div class="phork-content"> <style type="text/css">/** * GeSHi (C) 2004 - 2007 Nigel McNie, 2007 - 2008 Benny Baumann * (http://qbnz.com/highlighter/ and http://geshi.org/) */ .javascript .de1, .javascript .de2 {font: normal normal 1em/1.2em monospace; margin:0; padding:0; background:none; vertical-align:top;} .javascript {font-family:monospace;} .javascript .imp {font-weight: bold; color: red;} .javascript li, .javascript .li1 {color: #DDD;} .javascript .ln {width:1px;text-align:right;margin:0;padding:0 2px;vertical-align:top;} .javascript .kw1 {color: #000066; font-weight: bold;} .javascript .kw2 {color: #003366; font-weight: bold;} .javascript .kw3 {color: #000066;} .javascript .co1 {color: #006600; font-style: italic;} .javascript .co2 {color: #009966; font-style: italic;} .javascript .coMULTI {color: #006600; font-style: italic;} .javascript .es0 {color: #000099; font-weight: bold;} .javascript .br0 {color: #009900;} .javascript .sy0 {color: #339933;} .javascript .st0 {color: #3366CC;} .javascript .nu0 {color: #CC0000;} .javascript .me1 {color: #660066;} .javascript span.xtra { display:block; } </style><div class="code"><table class="javascript"><tbody><tr class="li1"><td class="ln"><pre class="de1">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 </pre></td><td class="de1"><pre class="de1">{   "apiVersion": "2.1",   "id": "1",   "data": {     "query": "chicago style pizza",     "time": "0.1",     "currentItemCount": 10,     "itemsPerPage": 10,     "startIndex": 11,     "totalItems": 2700000,     "nextLink": "http://www.google.com/search?hl=en&q=chicago+style+pizza&start=20&sa=N"     "previousLink": "http://www.google.com/search?hl=en&q=chicago+style+pizza&start=0&sa=N",     "pagingLinkTemplate": "http://www.google.com/search/hl=en&q=chicago+style+pizza&start={index}&sa=N",     "items": [       {         "title": "Pizz'a Chicago Home Page"         // More fields for the search results       },       "// More search results"     ]   } }  </pre></td></tr></tbody></table></div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/322/rev-raw/6cbda0bc6026f454542da1376d6cc1b601c4bb9d/google-json.json" style="float: right">view raw source</a> <a href="https://p.cweiske.de/322#google-json.json">google-json.json</a> </div> </div> <div class="phork-file"> <div class="phork-content"> <style type="text/css">/** * GeSHi (C) 2004 - 2007 Nigel McNie, 2007 - 2008 Benny Baumann * (http://qbnz.com/highlighter/ and http://geshi.org/) */ .javascript .de1, .javascript .de2 {font: normal normal 1em/1.2em monospace; margin:0; padding:0; background:none; vertical-align:top;} .javascript {font-family:monospace;} .javascript .imp {font-weight: bold; color: red;} .javascript li, .javascript .li1 {color: #DDD;} .javascript .ln {width:1px;text-align:right;margin:0;padding:0 2px;vertical-align:top;} .javascript .kw1 {color: #000066; font-weight: bold;} .javascript .kw2 {color: #003366; font-weight: bold;} .javascript .kw3 {color: #000066;} .javascript .co1 {color: #006600; font-style: italic;} .javascript .co2 {color: #009966; font-style: italic;} .javascript .coMULTI {color: #006600; font-style: italic;} .javascript .es0 {color: #000099; font-weight: bold;} .javascript .br0 {color: #009900;} .javascript .sy0 {color: #339933;} .javascript .st0 {color: #3366CC;} .javascript .nu0 {color: #CC0000;} .javascript .me1 {color: #660066;} .javascript span.xtra { display:block; } </style><div class="code"><table class="javascript"><tbody><tr class="li1"><td class="ln"><pre class="de1">1 2 3 4 5 6 7 8 </pre></td><td class="de1"><pre class="de1">{   "links": {     "self": "http://example.com/articles",     "next": "http://example.com/articles?page[offset]=2",     "last": "http://example.com/articles?page[offset]=10"   },   "data": [] }</pre></td></tr></tbody></table></div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/322/rev-raw/6cbda0bc6026f454542da1376d6cc1b601c4bb9d/jsonapi.org-links.json" style="float: right">view raw source</a> <a href="https://p.cweiske.de/322#jsonapi.org-links.json">jsonapi.org-links.json</a> </div> </div> <div class="phork-file"> <div class="phork-content"> <style type="text/css">/** * GeSHi (C) 2004 - 2007 Nigel McNie, 2007 - 2008 Benny Baumann * (http://qbnz.com/highlighter/ and http://geshi.org/) */ .javascript .de1, .javascript .de2 {font: normal normal 1em/1.2em monospace; margin:0; padding:0; background:none; vertical-align:top;} .javascript {font-family:monospace;} .javascript .imp {font-weight: bold; color: red;} .javascript li, .javascript .li1 {color: #DDD;} .javascript .ln {width:1px;text-align:right;margin:0;padding:0 2px;vertical-align:top;} .javascript .kw1 {color: #000066; font-weight: bold;} .javascript .kw2 {color: #003366; font-weight: bold;} .javascript .kw3 {color: #000066;} .javascript .co1 {color: #006600; font-style: italic;} .javascript .co2 {color: #009966; font-style: italic;} .javascript .coMULTI {color: #006600; font-style: italic;} .javascript .es0 {color: #000099; font-weight: bold;} .javascript .br0 {color: #009900;} .javascript .sy0 {color: #339933;} .javascript .st0 {color: #3366CC;} .javascript .nu0 {color: #CC0000;} .javascript .me1 {color: #660066;} .javascript span.xtra { display:block; } </style><div class="code"><table class="javascript"><tbody><tr class="li1"><td class="ln"><pre class="de1">1 2 3 4 5 6 7 8 9 </pre></td><td class="de1"><pre class="de1">{     "links": {         "first": 0,         "last": 10,         "prev": 1,         "next": 3,     },     "data": [] }</pre></td></tr></tbody></table></div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/322/rev-raw/6cbda0bc6026f454542da1376d6cc1b601c4bb9d/jsonapi.org-next.json" style="float: right">view raw source</a> <a href="https://p.cweiske.de/322#jsonapi.org-next.json">jsonapi.org-next.json</a> </div> </div> <div class="phork-file"> <div class="phork-content"> <style type="text/css">/** * GeSHi (C) 2004 - 2007 Nigel McNie, 2007 - 2008 Benny Baumann * (http://qbnz.com/highlighter/ and http://geshi.org/) */ .javascript .de1, .javascript .de2 {font: normal normal 1em/1.2em monospace; margin:0; padding:0; background:none; vertical-align:top;} .javascript {font-family:monospace;} .javascript .imp {font-weight: bold; color: red;} .javascript li, .javascript .li1 {color: #DDD;} .javascript .ln {width:1px;text-align:right;margin:0;padding:0 2px;vertical-align:top;} .javascript .kw1 {color: #000066; font-weight: bold;} .javascript .kw2 {color: #003366; font-weight: bold;} .javascript .kw3 {color: #000066;} .javascript .co1 {color: #006600; font-style: italic;} .javascript .co2 {color: #009966; font-style: italic;} .javascript .coMULTI {color: #006600; font-style: italic;} .javascript .es0 {color: #000099; font-weight: bold;} .javascript .br0 {color: #009900;} .javascript .sy0 {color: #339933;} .javascript .st0 {color: #3366CC;} .javascript .nu0 {color: #CC0000;} .javascript .me1 {color: #660066;} .javascript span.xtra { display:block; } </style><div class="code"><table class="javascript"><tbody><tr class="li1"><td class="ln"><pre class="de1">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 </pre></td><td class="de1"><pre class="de1">{    "total": 50,    "per_page": 15,    "current_page": 1,    "last_page": 4,    "next_page_url": "http://laravel.app?page=2",    "prev_page_url": null,    "from": 1,    "to": 15,    "data":[         {             // Result Object         },         {             // Result Object         }    ] }</pre></td></tr></tbody></table></div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/322/rev-raw/6cbda0bc6026f454542da1376d6cc1b601c4bb9d/laravel-pagination.json" style="float: right">view raw source</a> <a href="https://p.cweiske.de/322#laravel-pagination.json">laravel-pagination.json</a> </div> </div> <div class="phork-file"> <div class="phork-content"> <style type="text/css">/** * GeSHi (C) 2004 - 2007 Nigel McNie, 2007 - 2008 Benny Baumann * (http://qbnz.com/highlighter/ and http://geshi.org/) */ .javascript .de1, .javascript .de2 {font: normal normal 1em/1.2em monospace; margin:0; padding:0; background:none; vertical-align:top;} .javascript {font-family:monospace;} .javascript .imp {font-weight: bold; color: red;} .javascript li, .javascript .li1 {color: #DDD;} .javascript .ln {width:1px;text-align:right;margin:0;padding:0 2px;vertical-align:top;} .javascript .kw1 {color: #000066; font-weight: bold;} .javascript .kw2 {color: #003366; font-weight: bold;} .javascript .kw3 {color: #000066;} .javascript .co1 {color: #006600; font-style: italic;} .javascript .co2 {color: #009966; font-style: italic;} .javascript .coMULTI {color: #006600; font-style: italic;} .javascript .es0 {color: #000099; font-weight: bold;} .javascript .br0 {color: #009900;} .javascript .sy0 {color: #339933;} .javascript .st0 {color: #3366CC;} .javascript .nu0 {color: #CC0000;} .javascript .me1 {color: #660066;} .javascript span.xtra { display:block; } </style><div class="code"><table class="javascript"><tbody><tr class="li1"><td class="ln"><pre class="de1">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 </pre></td><td class="de1"><pre class="de1">{   "_metadata":   {       "page": 5,       "per_page": 20,       "page_count": 20,       "total_count": 521,       "Links": [         {"self": "/products?page=5&per_page=20"},         {"first": "/products?page=0&per_page=20"},         {"previous": "/products?page=4&per_page=20"},         {"next": "/products?page=6&per_page=20"},         {"last": "/products?page=26&per_page=20"},       ]   },   "records": [     {       "id": 1,       "name": "Widget #1",       "uri": "/products/1"     },     {       "id": 2,       "name": "Widget #2",       "uri": "/products/2"     },     {       "id": 3,       "name": "Widget #3",       "uri": "/products/3"     }   ] }</pre></td></tr></tbody></table></div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/322/rev-raw/6cbda0bc6026f454542da1376d6cc1b601c4bb9d/stackoverflow-12168624.json" style="float: right">view raw source</a> <a href="https://p.cweiske.de/322#stackoverflow-12168624.json">stackoverflow-12168624.json</a> </div> </div> <div class="phork-file"> <div class="phork-content"> <style type="text/css">/** * GeSHi (C) 2004 - 2007 Nigel McNie, 2007 - 2008 Benny Baumann * (http://qbnz.com/highlighter/ and http://geshi.org/) */ .javascript .de1, .javascript .de2 {font: normal normal 1em/1.2em monospace; margin:0; padding:0; background:none; vertical-align:top;} .javascript {font-family:monospace;} .javascript .imp {font-weight: bold; color: red;} .javascript li, .javascript .li1 {color: #DDD;} .javascript .ln {width:1px;text-align:right;margin:0;padding:0 2px;vertical-align:top;} .javascript .kw1 {color: #000066; font-weight: bold;} .javascript .kw2 {color: #003366; font-weight: bold;} .javascript .kw3 {color: #000066;} .javascript .co1 {color: #006600; font-style: italic;} .javascript .co2 {color: #009966; font-style: italic;} .javascript .coMULTI {color: #006600; font-style: italic;} .javascript .es0 {color: #000099; font-weight: bold;} .javascript .br0 {color: #009900;} .javascript .sy0 {color: #339933;} .javascript .st0 {color: #3366CC;} .javascript .nu0 {color: #CC0000;} .javascript .me1 {color: #660066;} .javascript span.xtra { display:block; } </style><div class="code"><table class="javascript"><tbody><tr class="li1"><td class="ln"><pre class="de1">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </pre></td><td class="de1"><pre class="de1">{         "books": [                 { "id": 6 },                 { "id": 7 },                 { "id": 8 },                 { "id": 9 },                 { "id": 10 }         ],         "meta": {                 "cursor": {                         "previous": null,                         "current": 5,                         "next": 10,                         "count": 5                 }         } }</pre></td></tr></tbody></table></div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/322/rev-raw/6cbda0bc6026f454542da1376d6cc1b601c4bb9d/thephpleague-cursor.json" style="float: right">view raw source</a> <a href="https://p.cweiske.de/322#thephpleague-cursor.json">thephpleague-cursor.json</a> </div> </div> <div class="phork-file"> <div class="phork-content"> <style type="text/css">/** * GeSHi (C) 2004 - 2007 Nigel McNie, 2007 - 2008 Benny Baumann * (http://qbnz.com/highlighter/ and http://geshi.org/) */ .javascript .de1, .javascript .de2 {font: normal normal 1em/1.2em monospace; margin:0; padding:0; background:none; vertical-align:top;} .javascript {font-family:monospace;} .javascript .imp {font-weight: bold; color: red;} .javascript li, .javascript .li1 {color: #DDD;} .javascript .ln {width:1px;text-align:right;margin:0;padding:0 2px;vertical-align:top;} .javascript .kw1 {color: #000066; font-weight: bold;} .javascript .kw2 {color: #003366; font-weight: bold;} .javascript .kw3 {color: #000066;} .javascript .co1 {color: #006600; font-style: italic;} .javascript .co2 {color: #009966; font-style: italic;} .javascript .coMULTI {color: #006600; font-style: italic;} .javascript .es0 {color: #000099; font-weight: bold;} .javascript .br0 {color: #009900;} .javascript .sy0 {color: #339933;} .javascript .st0 {color: #3366CC;} .javascript .nu0 {color: #CC0000;} .javascript .me1 {color: #660066;} .javascript span.xtra { display:block; } </style><div class="code"><table class="javascript"><tbody><tr class="li1"><td class="ln"><pre class="de1">1 2 3 4 5 6 7 8 9 10 11 12 13 </pre></td><td class="de1"><pre class="de1">{     "ids": [         385752029,         602890434,         ...         333181469,         333165023     ],     "next_cursor": 1374004777531007833,     "next_cursor_str": "1374004777531007833",     "previous_cursor": 0,     "previous_cursor_str": "0" }</pre></td></tr></tbody></table></div> </div> <div class="phork-meta"> <a href="https://p.cweiske.de/322/rev-raw/6cbda0bc6026f454542da1376d6cc1b601c4bb9d/twitter.json" style="float: right">view raw source</a> <a href="https://p.cweiske.de/322#twitter.json">twitter.json</a> </div> </div> </div>