API Продукта — документация

GET /products Получить список всех продуктов ▼

Возвращает массив объектов продуктов. Поддерживает пагинацию через параметры limit и skip.

Параметры запроса (query)

Имя	Тип	Обязательный	Описание
limit	integer	❌	Максимальное количество записей (по умолчанию 10)
skip	integer	❌	Смещение для пагинации (по умолчанию 0)
select	string	❌	Поля, которые нужно вернуть (через запятую)

Пример ответа (200 OK)

{
                        "products": [
                        {
                        "id": 1,
                        "title": "Смартфон X",
                        "price": 599.99,
                        "category": "Электроника",
                        "stock": 25,
                        "rating": 4.7
                        }
                        ],
                        "total": 100,
                        "skip": 0,
                        "limit": 10
                    }

▶ Try it out (демо)

GET /products/{id} Получить продукт по ID ▼

Возвращает полную информацию о продукте с указанным идентификатором.

Параметры пути (path)

Имя	Тип	Обязательный	Описание
id	integer	✅	Уникальный идентификатор продукта

Пример ответа (200 OK)

{
                        "id": 5,
                        "title": "Наушники Pro",
                        "description": "Беспроводные наушники с шумоподавлением",
                        "price": 199.99,
                        "discountPercentage": 12.5,
                        "rating": 4.8,
                        "stock": 42,
                        "category": "Аудио",
                        "thumbnail": "https://example.com/img/headphones.jpg"
                    }

▶ Try it out (демо)

POST /products Создать новый продукт ▼

Добавляет новый продукт в каталог. В теле запроса необходимо передать данные продукта.

Тело запроса (body)

Имя	Тип	Обязательный	Описание
title	string	✅	Название продукта
price	number	✅	Цена в долларах
category	string	❌	Категория продукта
stock	integer	❌	Количество на складе
description	string	❌	Описание продукта

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

{
                        "title": "Новый смартфон",
                        "price": 799.99,
                        "category": "Электроника",
                        "stock": 15,
                        "description": "Мощный смартфон с большим экраном"
                    }

Пример ответа (201 Created)

{
                        "id": 101,
                        "title": "Новый смартфон",
                        "price": 799.99,
                        "category": "Электроника",
                        "stock": 15,
                        "description": "Мощный смартфон с большим экраном",
                        "rating": 0
                    }

▶ Try it out (демо)

PUT /products/{id} Полностью обновить продукт ▼

Заменяет все поля существующего продукта. Если продукт не найден, возвращает ошибку.

Параметры пути

Имя	Тип	Обязательный	Описание
id	integer	✅	ID обновляемого продукта

Тело запроса (полный объект)

{
                        "title": "Обновлённый смартфон",
                        "price": 699.99,
                        "category": "Электроника",
                        "stock": 20,
                        "description": "Обновлённая модель с улучшенной камерой"
                    }

Пример ответа (200 OK)

{
                        "id": 5,
                        "title": "Обновлённый смартфон",
                        "price": 699.99,
                        "category": "Электроника",
                        "stock": 20,
                        "description": "Обновлённая модель с улучшенной камерой",
                        "rating": 4.5
                    }

▶ Try it out (демо)

DELETE /products/{id} Удалить продукт ▼

Удаляет продукт по указанному ID. Возвращает подтверждение удаления.

Параметры пути

Имя	Тип	Обязательный	Описание
id	integer	✅	ID удаляемого продукта

Пример ответа (200 OK)

{
                        "message": "Продукт с ID 5 успешно удалён",
                        "deletedId": 5
                    }

▶ Try it out (демо)

📦 API Продукта

📋 Модель данных — Продукт