Ответ
Для описания задач Backend важно четко структурировать требования, чтобы разработчик мог быстро понять суть и приступить к реализации.
Ключевые элементы:
- Цель задачи – кратко, зачем это нужно (например, "Добавить эндпоинт для получения списка пользователей").
- Технические детали – методы API, параметры, ожидаемый ответ, ошибки.
- Бизнес-логика – правила обработки данных (например, "Фильтрация по роли, если role=admin").
- Зависимости – связанные сервисы, БД, сторонние API.
- Критерии приемки – тесты, валидации, требования к производительности.
Пример:
**Задача:** Добавить GET /api/users
**Цель:** Получение списка пользователей с пагинацией.
**Параметры:**
- page (int, default=1)
- limit (int, default=10, max=100)
**Ответ:**
{ users: [...], total: 100 }
**Ошибки:** 400 – неверные параметры, 500 – серверная ошибка.
**Критерии:**
- Тесты на валидацию параметров.
- Логирование ошибок.
Чем конкретнее – тем меньше вопросов у разработчика.