6
ページングのパラメータを使用してRest APIを実装する場合、ページングのインデックスはゼロまたは1から開始する必要があります。パラメータはPageおよびPageSizeになります。私にとってAPI内でページングのインデックスをゼロにする必要がありますか?
我々はページ
ページングのパラメータを使用してRest APIを実装する場合、ページングのインデックスはゼロまたは1から開始する必要があります。パラメータはPageおよびPageSizeになります。私にとってAPI内でページングのインデックスをゼロにする必要がありますか?
我々はページ
について話しているので、それには標準がありません、1から開始することは理にかなって。周りを見てみましょう:さまざまなアプローチを使用して数十万のAPIがあります。
私はページネーションのために、次のいずれかの方法を使用して知っているのAPIのほとんどは:
offset
とlimit
またはpage
とどちらsize
は0
または1
をインデックス化することができます。どちらが良いですか?それはあなた次第です。
あなたのニーズに合ったものを選んで、を正しく文書化してください。。
さらに、ページ間のナビゲーションを容易にするために、応答ペイロードにいくつかのリンクを提供することができます。
は、たとえば、あなたがそう2ページからデータを読んでいる、前のページ(1)のために、次のページ(3ページ)のリンクを提供し考えてみましょう:
{
"data": [
...
],
"paging": {
"previous": "http://api.example.com/foo?page=1&size=10",
"next": "http://api.example.com/foo?page=3&size=10"
}
}
と覚えて、常にあなたはあなたが使用したいと思います。
ので、1を使用し、それを適切に文書化:) –
まあ、はい!それは、私が人々が何年にもわたって決定を批判してくれることを嫌っている決定段階の1つです! もちろん、ある人の場合は片方を、もう一方の方の場合は..私はちょうど何かを選んでそれに行くのがうれしいです! –
数十種類の異なるアプローチを使用して数十万のAPIがあります。ちょうどあなたに合ったアプローチを選んでください。そして、もう一度*正しく文書化してください。あなたが使いたいAPIを作ってください。 –