Paginación y ordenamiento

Paginación

La paginación es una técnica que se usa para dividir muchos resultados en fragmentos más pequeños, o páginas, para una navegación más sencilla. Al usar nuestra API de Mono, el cliente puede especificar dos parámetros: page_size y page_number en los endpoints que listan objetos. Estos parámetros pueden pasarse como query parameters en la solicitud a la API.

El parámetro page_size determina la cantidad de resultados que se deben devolver en cada página. Por ejemplo, si page_size se ajusta en 10, la API devolverá 10 resultados por página.

El parámetro page_number determina qué página de resultados se debe devolver. Por ejemplo, si page_number se ajusta en 2, la API devolverá la segunda página de resultados.

Cada lista de elementos devuelta por la API debe incluir un objeto de paginación con la siguiente estructura:

{
  "items": [],
  "pagination": {
    "page_number": 1,
    "page_size": 10,
    "total_items": 100,
    "total_pages": 10
  }
}

El campo items contiene la lista de objetos devueltos por la API para la página actual. El objeto pagination contiene metadatos sobre los resultados, incluyendo el page_number y page_size actuales, así como total_items y total_pages.

El campo total_items indica la cantidad total de objetos en el conjunto de resultados, y total_pages indica la cantidad total de páginas necesarias para mostrar todos los resultados. El cliente puede usar esta información para construir controles de UI que naveguen entre las páginas de resultados.

Ordenamiento

El ordenamiento es una técnica que se usa para reorganizar los elementos de una lista en un orden particular, ascendente o descendente. Al usar una API de ordenamiento, el cliente puede especificar un parámetro de sort en un query string.

El parámetro de sort debe incluir dos campos: type y field. El campo type determina el orden y puede tener los valores asc para ascendente o desc para descendente. El campo field especifica el campo por el cual se deben ordenar los elementos; los valores para este campo están documentados en cada endpoint que soporta estos parámetros de ordenamiento.

Por ejemplo, el siguiente query string ordenaría los elementos en orden ascendente por el campo id:

?sort[type]=asc&sort[field]=id