文档

7. 分页

API 中集合的响应是分页的。这意味着虽然一个集合可能包含数万甚至数十万个对象,但在每个 Web 请求中,出于 API 性能原因,只返回有限数量的结果。

当您获得集合的结果时,您将看到类似以下内容

{'count': 25, 'next': 'http://testserver/api/v2/some_resource?page=2', 'previous': None, 'results': [ ... ] }

要获取下一页,只需请求由 'next' 顺序 URL 给出的页面。

使用 page_size=XX 查询字符串参数更改每个请求返回的结果数量。

page_size 的默认最大限制配置为 200,当用户尝试使用超出该限制的值时(例如,?page_size=1000)会强制执行该限制。但是,您可以通过在 /etc/tower/conf.d/<some file>.py 中设置值来更改此限制,例如 MAX_PAGE_SIZE=1000

使用 page 查询字符串参数检索特定页面上的结果。

http://<Tower server name>/api/v2/model_verbose_name?page_size=100&page=2

与结果一起返回的先前和下一个链接将自动设置这些查询字符串参数。

序列化程序非常高效,但您可能不应该请求超过几百页的大小。

用户界面使用较小的值,以避免用户不得不进行大量滚动。