SA Шпаргалка

Все ответы в 2 клика

Базовый

Какие обязательные разделы должны быть в описании метода REST API?

Аналитик должен описать метод так, чтобы у фронтендера не осталось вопросов:

1. Endpoint: Метод и URL (PATCH /v1/users/{id}).
2. Описание: Бизнес-смысл (Частичное обновление профиля).
3. Авторизация: Требуемые роли (например, USER, ADMIN).
4. Параметры: Path (id), Query (фильтры), Headers.
5. Request Body: Структура JSON, типы данных, обязательность, ограничения (длина, regex).
6. Response: Примеры успешного ответа (200 OK) и структура возвращаемого JSON.
7. Ошибки: Список возможных статус-кодов (400, 403, 404) с описанием бизнес-причин (например, "404 - Пользователь не найден").

Ещё вопросы раздела «Документация»

Все вопросы раздела «Документация»