🔎 Что входит в хорошую постановку задачи на REST API-метод? 🔎

✅ 1. Общее описание
+ что делает этот метод?
+ для кого он?
+ почему мы его делаем?

✅ 2. Алгоритм работы - Use Case
+ основной сценарий
+ обработка ошибок


Требования к реализации:

✅ 3. Тип метода и полный URL

✅ 4. Query-параметры и их логика

✅ 5. Headers и их логика

✅ 6. Body (json) - Тело запроса

✅ 7. Аутентификация и авторизация запросов

✅ 8. Описание успешного ответа:
+ HTTP-статус код
+ Headers
+ Body (json) - тело ответа

✅ 9. Список обрабатываемых ошибок:
+ HTTP-статус код
+ Headers
+ Body (json) - тело ответа
Не описали ошибку? Значит её обработка не поддерживается.

Перечисленные выше требования (3-9) часто описывают с примерами запросов и ответов. Это самый лучший способ.



✅ 10. Маппинг данных для параметров API с БД
В маппинг включают: path-параметры, query-параметы, json-ы запроа и ответа, headers (если требуется).



✅ + 11. НФТ
Например, ограничения на кол-во запросов с одного ip или от одного клиента.

✅ + 12. Логирование и мониторинг
+ что логировать и где
+ при каких условиях, либо всегда
+ как долго хранить логи
+ требования к дашбордам мониторинга

✅ + 13. Дополнительно
+ Ответственная команда
+ Известные ошибки и проблемы
+ Требования к монетизации
+ Требования к кэшированию
+ Cookies - можно, но не нужно, они не рекомендуются для REST API



📌 Используйте пост как чеклист.
Проверьте, что у вас на работе учитываются все необходимые разделы в постановке задачи.

🧐 Что делают разработчики по тем пунктам, где требования сейчас не описываются, как принимают решения?

Этот чек-лист поможет задать правильные вопросы и избежать «дырок» в описании требований.

А если хочется дополнительных пояснений по наполнению, то можно почитать нашу статью Структура постановки задачи на REST API метод.


Сохраняйте, чтобы не потерять ✨

#RestApiGA