Siguiendo otra publicación sobre las buenas prácticas de uso de las APIs, hoy hablaremos sobre paginación. Pero en el caso que usted se haya perdido alguna de los otras publicaciones aquí están: HTTP Status y APIs y sus métodos de uso

Paginación de las APIs

Siempre que hubiere la necesidad del retorno de mayores detalles sobre alguno de los atributos del recurso deseado, el parámetro de paginación podrá ser utilizado.

Este uso es necesario para que evite que la consulta ejecutada en la API se quede sobrecargada, ocasionando time-out al utilizar la determinada solicitud. En general en todos los servicios que retornan una gran cantidad de datos se debe siempre utilizar la paginación para devolver los registros.

Junto a la paginación, será necesario indicar la cantidad de informaciones a ser retornadas en cada página. Con esto, se recomienda conjuntamente la utilización del parámetro de tamaño y que tenga este valor de size inferior a 200, dependiendo del tipo de consulta e informaciones a ser retornadas en el caso contrario.

La utilización de estas informaciones junto a la consulta ejecutada hace que la solicitud se torne más rápida de lectura y de retorno del backend, ocasionando así una experiencia más agradable y ágil para el desarrollador que está consumiendo la API.

O sea, mejora la experiencia de uso y evita un procesamiento de información de forma muy extensa, pudiendo ocurrir falla e incluso la interrupción de esta lectura (ocasionando el time-out, donde el backend no retorna las informaciones en el tiempo hábil necesario).

Un ejemplo en la práctica de cómo insertar esta información en el endpoint es a través page=0&size=100.

Recuerde que estas nomenclaturas de campo del parámetro podrán cambiar de acuerdo con la implementación de su AP (pudiendo encontrar estos campos como Page y Size; Offset y Limit; Page y Page Size; entre otros).

Utilizando filtros

Otro gran apoyo en la optimización de consultas de informaciones es el uso de filtros.

Suministrar este uso dentro de su integración también es de gran ayuda a la hora de una mejor experiencia de uso de las APIs.

A través de este recurso, será posible para el desarrollador limitar las informaciones que desea tener retornadas, optimizando las solicitudes ejecutadas para específicamente lo que es necesario.

Suponiendo que en la solicitud usted desea que sean retornadas solamente las informaciones que se encuentren con el status de aprobado, usted podrá insertar en su solicitud el filtro status=approved (recordando nuevamente que estas nomenclaturas dependerán de la implementación de su API), delimitando así los retornos solamente para este escenario. 

¿¡Ahora usted ya está apto y conociendo todos las recomendaciones y formas correctas de utilización de APIs?!