在我們的辦公室,我們正在就公共API中的一些參數進行激烈的討論。針對限制結果的API命名?
無處不在,我們提供給某些類型的獲取者,我們希望能夠限制結果(用於分頁)。
即:getPosts/getNews/getUsers/.../
應該能夠返回項目0到25,50到100等 所以,我們需要兩個參數。第一個參數是我們開始的地方,第二個參數是我們結束的地方。
那麼,第二個參數應該是絕對的還是相對的呢? (50,75應該返回項目50-75還是50-125?)
我們已經決定了相對,所以第二個參數告訴我們要返回多少項。
棘手的部分是以一種清晰而一致的方式命名。我們已經提出了迄今爲止的:
第一:
start/index/offset/page/pageindex
二:
amount/count/maxcount/limit/perpage/pagesize
有優點和缺點,每一個建議。使用「頁面」會使其不清楚它是從0還是1開始。使用「索引」或「偏移量」在這方面會更清楚,但更具技術性(畢竟,用戶在99%時間)。
我想這是非常主觀的,但我尋找明確的優點和缺點,並可能的良好的API和他們正在使用的例子。
我同意 - 混合/假設一個頁面上的記錄數... – Tim 2009-02-26 19:59:18