Перейти к содержанию

Пагинация

Для запросов, которые возвращают список объектов, есть возможность пагинации выдачи.

Для этого в запрос нужно добавить следующие параметры:

Параметр Тип Описание
page int Номер страницы
size int Количество объектов, отображаемых на странице

Если не указать количество объектов, отображаемых на странице, то по умолчанию отобразится 10 объектов.

Выбор страниц начинается с нулевой страницы (0). Количество и номер страницы в запросе описаны натуральными числами (начиная с 1). Таким образом в запросе page=0 соответствует первой странице.

Структура и описание JSON-объекта page:

Поле Тип Описание
size number Максимальное количество элементов, отображаемых на странице
totalElements number Общее количество элементов
totalPages number Общее количество страниц
number number Текущая страница

Пример параметра запроса

Запрос /user?page=1&size=2

Возвращаемый JSON:

        
{
    "_embedded": {
        "userList": [
            {
                "id": "61e8fd05-aaaa-aaaa-aaaa-db72c2c33326",
                "username": "user1",
                "name": "name",
                "surname": "surname",
                "fullName": "name surname",
                "avatar": "https://gitflic.ru/upload/img/6ea2b7e0-aaaa-aaaa-aaaa-7120f2ce03c1.jpg"
            },
            {
                "id": "25a7e267-aaaa-aaaa-aaaa-b9842af9804d",
                "username": "user2",
                "name": "name",
                "surname": "surname",
                "fullName": "name surname",
                "avatar": "https://gitflic.ru/upload/img/6ea2b7e0-aaaa-aaaa-aaaa-7120f2ce03c1.jpg"
            }
        ]
    },
    "page": {
        "size": 2,
        "totalElements": 12,
        "totalPages": 6,
        "number": 2
    }
}