Skip to main content

Qué es

La paginación te permite recuperar colecciones grandes en respuestas delimitadas. Los endpoints de lista de YCloud utilizan paginación por número de página o por cursor.

Antes de comenzar

Consulta la referencia del endpoint para conocer los parámetros de paginación, filtros, orden de clasificación y estructura de respuesta admitidos. No asumas que todos los endpoints de lista utilizan la misma estrategia.

Cómo funciona

Solicita una página, procesa sus elementos y continúa hasta que la respuesta indique que no existe una página siguiente. Mantén los mismos filtros y ajustes de ordenación durante todo el recorrido.

Solicitud y respuesta

Paginación por número de página

La mayoría de los endpoints de lista admiten estos parámetros de consulta:
La respuesta de una página contiene:
Los endpoints basados en desplazamiento suelen limitar tanto page como limit a 100, lo que limita el recorrido a los primeros 10 000 elementos. Comprueba los límites de cada endpoint y utiliza la paginación por cursor cuando sea compatible y necesites un conjunto de resultados mayor.
Continúa solicitando la siguiente página mientras length sea igual a limit. Deténte cuando length sea menor que limit.

Paginación por cursor

Los endpoints que devuelven cursor.after admiten paginación por cursor. Envía ese valor como pageAfter en la siguiente solicitud.
Una respuesta por cursor contiene items, limit, length y, cuando existen más resultados, cursor.after. El objeto de cursor solo lo devuelven los endpoints que admiten paginación por cursor.
Pasa el cursor devuelto sin cambios a la siguiente solicitud. Trátalo como opaco; no lo modifiques ni lo almacenes como un identificador de aplicación a largo plazo. Deténte cuando length sea 0 o la respuesta ya no contenga cursor.after.
Los parámetros de paginación y filtro varían según el endpoint. Consulta la referencia de la API antes de implementar una operación de lista.

Lista de verificación para la implementación

  • Define un limit explícito en lugar de depender del valor predeterminado.
  • Mantén los filtros entre solicitudes de página.
  • Deténte en función de la condición de la respuesta, no de un recuento de páginas estimado.
  • Maneja una primera página vacía como un resultado exitoso.
  • Añade un límite de seguridad de páginas o elementos máximos para tareas en segundo plano.