API документация¶
Общая информация¶
- Базовый URL:
https://api.example.com/v1 - Формат данных: JSON
- Аутентификация: Bearer Token (JWT)
Эндпоинты¶
GET /students¶
Получение списка студентов
Параметры запроса:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| group | string | нет | Фильтр по группе |
| course | int | нет | Фильтр по курсу |
| limit | int | нет | Количество записей (по умолч. 20) |
| offset | int | нет | Смещение для пагинации |
Пример запроса: ```bash curl -X GET "https://api.example.com/v1/students?group=ИВТ-201&limit=10" \ -H "Authorization: Bearer ваш_токен"
Пример ответа: { "success": true, "data": [ { "id": 1, "last_name": "Иванов", "first_name": "Иван", "group": "АПИб-22", "course": 2 } ], "total": 25, "limit": 10, "offset": 0 } POST /studentsСоздание нового студентаТело запроса:JSON{ "last_name": "Петров", "first_name": "Петр", "middle_name": "Петрович", "birth_date": "2005-03-15", "group": "ИВТ-202", "student_id": "2024002" } Ответ:JSON{ "success": true, "data": { "id": 2, "message": "Студент успешно создан" } } GET /students/{id}Получение студента по IDПараметры пути:id (int) – идентификатор студентаОтвет:JSON{ "success": true, "data": { "id": 1, "last_name": "Иванов", "first_name": "Иван", "middle_name": "Иванович", "birth_date": "2005-01-01", "group": "АПИб-22", "course": 2, "grades": [ { "subject": "Математика", "grade": 5, "date": "2025-02-20" } ] } }
Код,Описание,Что делать 400,Неверный запрос,Проверьте параметры 401,Не авторизован,Проверьте токен 403,Доступ запрещён,Недостаточно прав 404,Не найдено,Проверьте ID ресурса 500,Ошибка сервера,Обратитесь в поддержку