Buenas prácticas: Paginación y filtros

Continuando con otro post sobre buenas prácticas en el uso de la API, hoy hablaremos de la paginación. En caso de que se hayan perdido alguno de los otros posts, aquí están: HTTP Status y las API y sus métodos

Paginación de las APIs

Siempre que sea necesario devolver más detalles sobre cualquiera de los atributos del recurso deseado, se puede utilizar el parámetro de paginación.

Este uso es necesario para evitar que la consulta ejecutada en la API se sobrecargue, causando un timeout al utilizar la solicitud dada. En general, para todos los servicios que devuelven grandes cantidades de datos, siempre se debe utilizar la paginación para devolver los registros.

Junto con la paginación, será necesario indicar la cantidad de información a devolver en cada página. Por lo tanto, se recomienda utilizar el parámetro del tamaño y que este valor sea inferior a 200, dependiendo del tipo de consulta y de la información que se devuelva en caso contrario.

El uso de esta información junto con la consulta ejecutada hace que la solicitud de lectura y el retorno del backend sean más rápidos, provocando así una experiencia más agradable y ágil para el desarrollador que está consumiendo la API.

Es decir, mejora la experiencia del usuario y evita un procesamiento de la información muy extenso, que puede causar fallos e incluso la interrupción de la lectura (provocando un timeout, en el que el backend no devuelve la información en el tiempo requerido).

En la práctica, un ejemplo de cómo insertar esta información en el punto final es a través de page=0&size=100.

Tenga en cuenta que estos nombres de los campos de parámetros pueden cambiar de acuerdo con la implementación de su AP (puede encontrar estos campos como Page and Size; Offset y Limit; Page y PageSize; entre otros).

Usando filtros

Otro gran apoyo para optimizar las consultas de información es el uso de filtros.

Proporcionar este uso dentro de su implementación es también de gran ayuda cuando se trata de una mejor experiencia en el uso de las API.

A través de esta característica, será posible para el desarrollador limitar la información que quiere que le sea devuelta, optimizando las solicitudes ejecutadas para lo que se necesita específicamente.

Suponiendo que en la solicitud sólo se desea el retorno de la información que está con el status aprobado, se puede insertar en la solicitud el filtro status=aprobado (recordando siempre que estas nomenclaturas dependerán de la implementación de su API), delimitando así los retornos sólo para este escenario.

Así que, ¡¿estás ahora listo y consciente de todas las recomendaciones y métodos correctos para hacer el mejor uso de las API?!

‍