La pagination de l'API est essentielle si vous avez affaire à beaucoup de données et de points de terminaison. La pagination implique automatiquement l'ajout d'ordre au résultat de la requête. L'ID d'objet est le résultat par défaut, mais les résultats peuvent également être triés d'autres manières.
À quoi sert la pagination ?
Par conséquent, la pagination agit comme un saut de page, laissant les utilisateurs réfléchir à leur prochain mouvement et leur fournissant les moyens de passer d'un ensemble d'éléments à un autre. La liste de numéros dans le modèle de pagination permet également aux utilisateurs de déterminer combien d'autres pages il reste à étudier.
Qu'est-ce que l'API REST de pagination ?
Plusieurs noms sont utilisés dans l'industrie pour les points de terminaison qui return un ensemble paginé, en particulier dans les API REST, tels que la ressource de collection, la liste des points de terminaison, les points de terminaison d'index, etc. … I je vais l'appeler "listing endpoints" dans tout le document.
Qu'est-ce que la réponse de pagination ?
Pagination dans l'API Square
Dans les points de terminaison de l'API Square, les résultats paginés incluent un champ cursor dans le corps de la réponse. Pour récupérer l'ensemble de résultats suivant, envoyez une demande de suivi au même point de terminaison et fournissez la valeur du curseur renvoyée dans la réponse précédente en tant que paramètre de requête.
Comment la pagination devrait-elle fonctionner ?
Bonnes pratiques de conception de pagination
- Fournir de grandes zones cliquables.
- Ne pas utiliser de soulignement.
- Identifier la page actuelle.
- Espacer la pageliens.
- Fournir les liens Précédent et Suivant.
- Utiliser les premier et dernier liens (le cas échéant)
- Mettre les liens Premier et Dernier à l'extérieur.
