在 Web 開發中,分頁是比較常見的需求。而 Collection JSON 格式是一種用于 Web API 返回的數據格式,能夠將數據與元數據一起返回。使用 Collection JSON 格式進行分頁,可以方便的返回當前頁數據、總共多少頁等信息。
下面是一份使用 Collection JSON 格式進行分頁的示例代碼:
{ "collection": { "version": "1.0", "href": "http://example.com/path/to/resource/", "links": [{ "rel": "next", "href": "http://example.com/path/to/resource/?page=2" }, { "rel": "prev", "href": "http://example.com/path/to/resource/?page=1" }, { "rel": "first", "href": "http://example.com/path/to/resource/?page=1" }, { "rel": "last", "href": "http://example.com/path/to/resource/?page=3" }], "items": [{ "href": "http://example.com/path/to/item/1", "data": [ {"name": "id", "value": 1}, {"name": "name", "value": "Alice"} ] }, { "href": "http://example.com/path/to/item/2", "data": [ {"name": "id", "value": 2}, {"name": "name", "value": "Bob"} ] }] } }
以上示例代碼中,links
中的rel
分別為next
、prev
、first
和last
,分別表示下一頁、上一頁、第一頁和最后一頁的鏈接。而items
則為當前頁的數據集合。
使用 Collection JSON 格式進行分頁,可以方便的返回分頁數據和元數據,讓開發者更加方便的進行前后端開發。同時,也可以讓客戶端更好的使用和顯示數據,提高了用戶體驗。