Pagination et limites d'utilisation

Principe de fonctionnement

L'API de La Vitrine implĂ©mente un systĂšme de pagination pour toutes les requĂȘtes de donnĂ©es. Cette approche permet d'optimiser les performances en limitant le volume de donnĂ©es transfĂ©rĂ©es par requĂȘte et offre une navigation fluide Ă  travers de grands ensembles de rĂ©sultats. Par dĂ©faut, les rĂ©ponses sont limitĂ©es Ă  10 Ă©lĂ©ments par page, mais ce paramĂštre est personnalisable. La pagination est essentielle pour gĂ©rer efficacement les collections volumineuses d'Ă©vĂ©nements, de lieux culturels ou de contributeurs.

ParamĂštres de pagination

Deux paramĂštres principaux vous permettent de contrĂŽler la pagination de vos requĂȘtes :

  • page : Indique la page de rĂ©sultats souhaitĂ©e (la numĂ©rotation commence Ă  1)

  • limit : DĂ©finit le nombre maximum d'Ă©lĂ©ments par page (valeur maximale autorisĂ©e : 100)

Exemple d'utilisation : /events?page=2&limit=20

Structure de la réponse

Chaque réponse paginée inclut une section pagination contenant les métadonnées suivantes :

  • total : Nombre total d'Ă©lĂ©ments correspondant Ă  la requĂȘte

  • page : Page actuelle

  • limit : Nombre d'Ă©lĂ©ments par page

  • totalPages : Nombre total de pages disponibles

  • nextPageUrl : URL complĂšte pour accĂ©der Ă  la page suivante (absent sur la derniĂšre page)

Cette structure facilite l'implémentation de la navigation entre les pages et permet d'informer les utilisateurs sur la quantité totale de données disponibles.

Last updated