列表翻頁

很多時(shí)候，當(dāng)您調(diào)用 SiteServer REST API 時(shí)，會(huì)返回很多結(jié)果，因此，我們需要對(duì)結(jié)果進(jìn)行分頁，以確保響應(yīng)更容易處理。

假設(shè)你需要獲取整個(gè)網(wǎng)站的內(nèi)容列表，其結(jié)果可能是數(shù)十萬頁的大規(guī)?；貞?yīng)，這可能導(dǎo)致長(zhǎng)時(shí)間的等待以及服務(wù)器性能受到影響；所以，我們?cè)诜祷亓斜頃r(shí)使用了默認(rèn)的限制（默認(rèn)返回 20 個(gè)結(jié)果），但是你可以通過顯式地設(shè)置限制參數(shù)，以確保獲得指定數(shù)量的結(jié)果。

設(shè)置限制參數(shù)

客戶端發(fā)起API請(qǐng)求時(shí)可以使用top和skip查詢參數(shù)來指定要返回的結(jié)果和集合中的偏移量。

當(dāng)客戶端同時(shí)提供top和skip參數(shù)時(shí)，服務(wù)器會(huì)首先應(yīng)用skip，然后在集合上應(yīng)用top。

以下限制參數(shù)可用于所有獲取列表的API中，如獲取用戶API、獲取內(nèi)容列表API等。

參數(shù)名	位置	類型	默認(rèn)值	說明
top	query	整數(shù)	20	返回的結(jié)果數(shù)量
skip	query	整數(shù)	0	集合中的偏移量

請(qǐng)求示例1

請(qǐng)求獲取指定站點(diǎn)下的前30篇內(nèi)容

GET /api/v1/contents/1325?top=30 HTTP/1.1Copy to clipboardErrorCopied

請(qǐng)求示例2

請(qǐng)求獲取指定站點(diǎn)下的第6到15篇內(nèi)容，同時(shí)

GET /api/v1/contents/1325?top=10&skip=5 HTTP/1.1Copy to clipboardErrorCopied

獲取翻頁結(jié)果

分頁響應(yīng)將通過在響應(yīng)中包含指定的值來返回翻頁所需的數(shù)據(jù)，如總條數(shù)、上一頁地址、下一頁地址等。缺少對(duì)應(yīng)的值意味著沒有其他頁面可用。

返回結(jié)果	類型	說明
value	數(shù)組	翻頁結(jié)果列表
first	字符串	第一頁的API訪問地址
prev	字符串	上一頁的API訪問地址
next	字符串	下一頁的API訪問地址
last	字符串	最后一頁的API訪問地址
count	整數(shù)	總條數(shù)

響應(yīng)示例

{     "value": [         {             "id": 2221,             "channelId": 1344,             "siteId": 1325,             "addUserName": "admin",             "lastEditUserName": "admin",             "writingUserName": "",             "lastEditDate": "2018-04-10 08:50:00",             "taxis": 6,             "groupNameCollection": "",             "tags": "",             "sourceId": 0,             "referenceId": 0,             "isChecked": "True",             "checkedLevel": 0,             "hits": 0,             "hitsByDay": 0,             "hitsByWeek": 0,             "hitsByMonth": 0,             "lastHitsDate": "2018-04-02 15:49:00",             "settingsXml": "titleformatstring=True_False_False_&check_isadmin=True&check_username=admin&check_checkdate=2018-04-02 下午 3:49",             "title": "標(biāo)題6",             "isTop": "False",             "isRecommend": "False",             "isHot": "True",             "isColor": "False",             "linkUrl": "",             "addDate": "2018-04-02 15:49:00",             "subTitle": "",             "imageUrl": "http://127.0.0.1/test17/upload/images/2018/4/7765a380c3d18abd.jpg",             "videoUrl": "",             "fileUrl": "",             "content": "",             "summary": "",             "author": "",             "source": "",             "titleformatstring": "True_False_False_",             "check_isadmin": "True",             "check_username": "admin",             "check_checkdate": "2018-04-02 下午 3:49",             "navigationUrl": "http://127.0.0.1/test17/news/201804/2221.html"         },         {             "id": 2223,             "channelId": 1344,             "siteId": 1325,             "addUserName": "admin",             "lastEditUserName": "admin",             "writingUserName": "",             "lastEditDate": "2018-05-06 11:05:00",             "taxis": 8,             "groupNameCollection": "",             "tags": "其他",             "sourceId": 0,             "referenceId": 0,             "isChecked": "True",             "checkedLevel": 0,             "hits": 5,             "hitsByDay": 2,             "hitsByWeek": 2,             "hitsByMonth": 2,             "lastHitsDate": "2018-06-15 00:00:00",             "settingsXml": "titleformatstring=False_False_False_&check_isadmin=True&check_username=admin&check_checkdate=2018-04-02 下午 3:49",             "title": "標(biāo)題8",             "isTop": "False",             "isRecommend": "False",             "isHot": "True",             "isColor": "False",             "linkUrl": "",             "addDate": "2018-04-02 15:49:00",             "subTitle": "",             "imageUrl": "http://127.0.0.1/test17/upload/images/2018/4/2a131c625f84a37d.jpg",             "videoUrl": "@/upload/videos/2018/5/acddd7e04837d00c.mp4",             "fileUrl": "http://127.0.0.1/test17/upload/images/2018/5/d9241fe1de65d4ea.jpg",             "content": "<p><img src=\"@/upload/images/2018/5/de0480c38737bbde.png\"/><img src=\"@/upload/images/2018/5/213add0d1ccf20e2.jpg\" title=\"ISO9001中文.jpg\" alt=\"ISO9001中文.jpg\"/><img src=\"@/upload/images/2018/5/7d2250f2955d1c09.png\"/></p>",             "summary": "",             "author": "",             "source": "",             "titleformatstring": "False_False_False_",             "check_isadmin": "True",             "check_username": "admin",             "check_checkdate": "2018-04-02 下午 3:49",             "navigationUrl": "http://127.0.0.1/test17/news/201804/2223.html"         }     ],     "first": "http://localhost/api/v1/contents/1325?top=2&skip=0",     "prev": "http://localhost/api/v1/contents/1325?top=2&skip=0",     "next": "http://localhost/api/v1/contents/1325?top=2&skip=4",     "last": "http://localhost/api/v1/contents/1325?top=2&skip=6",     "count": 8 }

本頁內(nèi)容由塔燈網(wǎng)絡(luò)科技有限公司通過網(wǎng)絡(luò)收集編輯所得，所有資料僅供用戶參考了本站不擁有所有權(quán)，如您認(rèn)為本網(wǎng)頁中由涉嫌抄襲的內(nèi)容，請(qǐng)及時(shí)與我們聯(lián)系，并提供相關(guān)證據(jù)，工作人員會(huì)在5工作日內(nèi)聯(lián)系您，一經(jīng)查實(shí)，本站立刻刪除侵權(quán)內(nèi)容。本文鏈接:http://m.jstctz.cn/18186.html