Paginación en la API
Las funciones que soportan paginación aceptan los siguientes parámetros opcionales vía query params:
Parámetro | Tipo | Descripción |
---|---|---|
limit | number | Número máximo de resultados por página. |
offset | number | Posición desde la cual comenzar a mostrar resultados (basado en índice cero). |
Comportamiento esperado
- Ambos valores pueden enviarse como números o strings numéricos.
- Si no se envía
limit
, se usará un valor por defecto de 10. - Si no se envía
offset
, se asumirá 0 (es decir, desde el primer elemento). - Si se envía un valor inválido (texto no numérico, número negativo, etc.), se usará el valor por defecto correspondiente.
- El
limit
tiene un máximo permitido de 100 para proteger el rendimiento de la API.
Formato de respuesta
La respuesta estará compuesta por:
data
: Contiene los elementos encontrados.meta
: Contiene los datos de paginación.
{
"success": true,
"code": 200,
"response": {
"data": [ /* resultados */ ],
"meta": {
"total": 135,
"limit": 10,
"offset": 0
}
}
}
Campo | Descripción |
---|---|
total | Número total de elementos disponibles. |
limit | Límite aplicado en esta solicitud. |
offset | Posición desde la que se inició la paginación. |