Эндпоинты REST API
Caution
Демонстрационная страница: это демонстрационная страница, показывающая возможность многовкладочной документации. Её содержимое приведено исключительно для иллюстрации.
Наш REST API предоставляет эндпоинты для доступа к данным и работы с ними. Все эндпоинты возвращают данные в формате JSON.
Базовый URL
Все запросы к API следует отправлять на следующий базовый URL:
https://api.example.com/v1Эндпоинты пользователей
Получить всех пользователей
GET /usersВозвращает список всех пользователей. Поддерживает параметры постраничного вывода.
Параметры запроса:
| Параметр | Тип | Описание |
|---|---|---|
| page | integer | Номер страницы (по умолчанию: 1) |
| limit | integer | Количество записей на странице (по умолчанию: 50, максимум: 100) |
| sort | string | Поле для сортировки (например, «name», «created_at») |
Ответ:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Получить пользователя по ID
GET /users/{id}Возвращает одного пользователя по идентификатору.
Ответ:
{ "data": { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z", "profile": { "bio": "Software developer", "location": "New York", "avatar_url": "https://example.com/avatars/john.jpg" } }}Эндпоинты товаров
Получить все товары
GET /productsВозвращает список всех товаров. Поддерживает фильтрацию и постраничный вывод.
Параметры запроса:
| Параметр | Тип | Описание |
|---|---|---|
| category | string | Фильтр по категории |
| min_price | number | Фильтр по минимальной цене |
| max_price | number | Фильтр по максимальной цене |
| page | integer | Номер страницы (по умолчанию: 1) |
| limit | integer | Количество записей на странице (по умолчанию: 50, максимум: 100) |
Ответ:
{ "data": [ { "id": "prod_123", "name": "Example Product", "description": "This is an example product", "price": 49.99, "category": "electronics" }, // More products... ], "meta": { "total": 350, "page": 1, "limit": 50 }}Обработка ошибок
Все эндпоинты используют стандартные коды состояния HTTP и при необходимости содержат подробные сообщения об ошибках:
| Код состояния | Описание |
|---|---|
| 200 | OK: запрос выполнен успешно |
| 400 | Bad Request: недопустимые параметры |
| 401 | Unauthorized: требуется аутентификация |
| 403 | Forbidden: недостаточно прав |
| 404 | Not Found: ресурс не существует |
| 429 | Too Many Requests: превышен лимит частоты запросов |
| 500 | Internal Server Error: произошла ошибка на сервере |
Ответы с ошибкой содержат сообщение, объясняющее, что пошло не так:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}