View All

Получение списка записей коллекции с поддержкой поиска, фильтрации и пагинации.

Базовый запрос

GET /v1/:project/:collection

Query-параметры

Параметр	Тип	По умолчанию	Описание
search	string	—	Поиск по текстовым полям
page	number	1	Номер страницы
perPage	number	25	Количество записей на странице
sort	string	createdAt	Поле для сортировки. -field — по убыванию, field — по возрастанию
fields	string	—	Список полей для возврата, через запятую
include	string	—	Список связанных записей для включения, через запятую

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

GET https://api.kodzero.pro/v1/:project/:collection?search=футб&page=1&perPage=10&sort=-price&fields=title,price

Ответ

{
  "ok": true,
  "result": {
    "page": 1,
    "perPage": 10,
    "total": 42,
    "totalPages": 5,
    "found": [
      {
        "_id": "69c156e129d4e3fab000a215",
        "title": "Футболка",
        "price": 1499.99,
        "createdAt": "2025-01-15T10:30:00Z",
        "updatedAt": "2025-01-15T10:30:00Z"
      }
    ]
  }
}

Поля ответа

Поле	Описание
page	Текущая страница
perPage	Записей на странице
total	Общее количество записей
totalPages	Общее количество страниц
found	Массив записей
_include	Связанные записи (если указан параметр include)

Поиск

Параметр search выполняет поиск по всем полям коллекции:

GET /v1/:project/:collection?search=apple

Пагинация

Для навигации по большим наборам данных используйте page и perPage:

# Первая страница, 25 записей
GET /v1/:project/:collection?page=1&perPage=25

# Вторая страница
GET /v1/:project/:collection?page=2&perPage=25

💡 Подсказка

В Kodzero SDK доступны удобные методы для работы с пагинацией и получением списка записей.

Сортировка

Параметр sort позволяет упорядочить записи по любому полю:

# По возрастанию цены
GET /v1/:project/:collection?sort=price

# По убыванию цены
GET /v1/:project/:collection?sort=-price

# По дате создания (по умолчанию)
GET /v1/:project/:collection?sort=createdAt

Выбор полей

Параметр fields позволяет запросить только необходимые поля, уменьшив размер ответа:

# Только название и цена
GET /v1/:project/:collection?fields=title,price

# С ID (всегда включается)
GET /v1/:project/:collection?fields=title,price,_id

📌 Имейте в виду

Поле _id включается автоматически, даже если не указано в fields.

Связанные записи

Параметр include позволяет включить связанные записи в один запрос.

Допустим, в коллекции products есть поля типа Связь, которая ссылается на элементы другой коллекции:

• category — связь типа single (одна категория)
• tags — связь типа multiple (несколько тегов)

# Прикрепить к ответу данные, связанной с товаром категории
GET /v1/:project/:collection?include=category

# Прикрепить к ответу данные, связанных полей category и tags
GET /v1/:project/:collection?include=category,tags

Связанные записи возвращаются в поле _include:

{
  "result": {
    "found": [...],
    "_include": {
      "category": [
        { "_id": "69c15092b84300bed74c5610", "name": "Одежда" }
      ],
      "tags": [
        { "_id": "69b920b41473230166d911bf", "name": "Новинка" },
        { "_id": "69c156e129d4e3fab000a265", "name": "Оверсайз" }
      ]
    }
  }
}

Фильтрация

βБета-версия

Фильтрация по полям работает в бета-режиме с ограничениями.

Любое поле коллекции можно использовать для фильтрации, указав его как query-параметр:

Точное совпадение

# Поиск по имени
GET /v1/:project/:collection?title=футболка

# Поиск по цене
GET /v1/:project/:collection?price=1499.99

Тип поля: Текст

Для текстовых полей поддерживается поиск по нескольким значениям (логическое ИЛИ):

# Поиск товаров, brand которых "фэшн" ИЛИ "дитейлз"
GET /v1/:project/:collection?brand=фэшн,дитейлз

# Поиск записей по значению поля status: "active" ИЛИ "draft"
GET /v1/:project/:collection?status=active,draft

Тип поля: Число

Поддерживается только точное совпадение:

# Товары с ценой 999
GET /v1/:project/:collection?price=999

# Товары с рейтингом 5
GET /v1/:project/:collection?rating=5

Тип поля: Да/Нет

Для булевых полей укажите нужное значение:

# Только активные записи
GET /v1/:project/:collection?active=true

# Только неактивные записи
GET /v1/:project/:collection?active=false

💡 Подсказка

Чтобы получить все записи (и true, и false), просто не указывайте булево поле в фильтре.

Тип поля: Список

Для полей типа массив поддерживается поиск "содержит одно из значений". Можно передать как одно значение, так и несколько через запятую:

# Записи, которые содержат "male"
GET /v1/:project/:collection?sex=male

# Записи, которые содержат "male" ИЛИ "female"
GET /v1/:project/:collection?sex=male,female

# Записи с языком "english"
GET /v1/:project/:collection?language=english

# Записи с языками "english" ИЛИ "russian"
GET /v1/:project/:collection?language=english,russian

Комбинирование фильтров

Можно комбинировать несколько фильтров (логическое И):

# Активные товары [active=true] бренда Banana [brand=banana] с ценой 999 [price=999]
GET /v1/:project/:collection?active=true&brand=banana&price=999

Ограничения бета-версии

• Дата и время: Фильтрация по датам пока не поддерживается
• Число: Только точное совпадение (без диапазонов и нескольких значений через запятую)