第 7 章 在 API 中使用分页


API 分页集合的响应。这意味着,虽然集合在每个 web 请求中可能包含几万或数百个对象,但出于 API 性能的原因,仅返回大量结果。

当您收到集合的结果时,会出现类似如下的内容:

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

流程

  1. 请求"下一步"顺序 URL 给出的页面,以进入下一页。
  2. 使用 page_size=XX 查询字符串参数更改每个请求返回的结果数。

    • page_size 的默认最大限值为 200,当用户尝试超过该值时(例如: ?page_size=1000 )强制执行该限制。但是,您可以通过将 /etc/tower/conf.d/<some file>.py 中的值设置为 更高的内容来更改这个限制。例如,MAX_PAGE_SIZE=1000
  3. 使用 page 查询字符串参数来检索特定结果页面:

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

与结果返回的前面的和以下链接会自动设置这些查询字符串参数。

不要请求大于 200 的页面大小。

用户界面使用较小的值来避免滚动。

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.