1

在我们的办公室，我们正在激烈讨论如何在我们的公共 API 中命名一些参数。

在我们为某种列表提供 getter 的任何地方，我们都希望能够限制结果（用于分页）。

即：getPosts/getNews/getUsers/.../应该能够返回项目 0 到 25、50 到 100 等。所以，我们需要两个参数。第一个参数是我们开始的地方，第二个参数是我们结束的地方。

那么，第二个参数应该是绝对的还是相对的？（应该 50,75 退回物品 50-75 还是 50-125？）

我们已经决定了相对，所以第二个参数告诉我们要返回多少项目。

棘手的部分是以清晰一致的方式命名。到目前为止，我们提出的那些：

第一的：

start/index/offset/page/pageindex

第二：

amount/count/maxcount/limit/perpage/pagesize

每个建议都有优点和缺点。使用“page”会让人不清楚它是从 0 开始还是从 1 开始。在这方面使用“index”或“offset”会更清楚，但更具技术性（毕竟，99% 的用户都在使用它进行分页）时间）。

我想这是非常主观的，但我正在寻找明确的利弊，以及好的 API 的示例以及它们使用的内容。

4

3 回答 3

3

我会选择相对的，它更容易掌握。

关于命名：我喜欢第一个结果的“开始”和结果数量的“计数”。

（但你不是以某种方式混合页面和结果计数吗？）

于 2009-02-18T14:26:00.223 回答
1

绝对去相对。我称它们为“索引”和“计数”。通常我会使用“长度”，但它似乎不适合你所描述的。如果你想让它类似于 linq，你可以调用参数“skip”和“take”。对于将要查看结果 URL 的 Joe Average 人来说，这些术语也更容易理解。

于 2009-02-18T14:32:27.010 回答
1

我会去

getPosts(startIndex, count)
于 2009-02-18T14:35:35.847 回答