TGViewer
IT АНАЛитика | Вильд Виктор IT АНАЛитика | Вильд Виктор @it_deep_sight · 2.07K subscribers
Post #232 1.89K
Шаблон_описания_метода_API_IT_АНАЛитика_.docx21.8 KB
В чате разработки начался сущий кошмар, когда они увидели этот метод

Я видел однажды, как он убил прод… методом.

В Джоне Уике (2014) Киану Ривз убил троих карандашом, но только не методом /GET и не на проде.
У нас же «оружием» иногда становится плохо описанный метод, который может завалить проект ничуть не хуже🤯.

Какие есть подводные?

1. Неясные входные параметры
Аналитик не указал, какие поля обязательные.
На проде метод вызывают без нужного параметра → упали.

2. Неопределённые типы данных
Ожидали int, прилетел string → через некоторое время приходит баг.

3. Нет описания ошибок и кодов ответа
Метод возвращает какой-то ответ, но без описания.
В итоге каждый понимает его по-своему.

4. Логика описана не полностью
Запись не найдена, сервис вернул пустой ответ, превышен лимит и т. д.
На проде это превращается в зависший UI или кривые данные.

5. Нет ограничений по производительности
Не уточнили, что метод должен отдавать максимум 50 записей.
Фронт запросил все транзакции клиента (500 строк) → таймаут, нагрузка, сервер лёг.

📎 В общем, делюсь шаблоном, который использую сам. Может, кто-то найдёт для себя что-то новое.

А у вас как описывают методы в проектах?

IT АНАЛитика | Подписаться
  • 🔥 10
  • 👍 5
  • ❤ 2
More from @it_deep_sight
  1. Sep 18, 2026Вот вам оффер пошел нах*й Часть 2 Как и обещал, вторая часть 🔥 Если пропустили первую, та…
  2. Sep 11, 2026Штош ты ментор сдал назад? Часть 2 Менторство почти подошло к концу. На картинке итоговый…
  3. Sep 8, 2026Коллеги, кто? IT АНАЛитика | Подписаться
  4. Sep 4, 2026Архитектурный паттерн "Метнись кабанчиком": разбираемся со Scatter/Gather Сейчас на рынке…
  5. Aug 27, 2026Почему Авито не подключает микросервисы к Kafka напрямую? Хороший кейс для разбора по сист…
  6. Aug 13, 2026Вот вам оффер пошел нах*й 🤝🤝 Прошлый пост про книгу собрал много реакций и репостов. Хоч…
Threads Profile ViewerView any public Threads profile without an account.Open ThreadLook →Writing with AI? Make it sound human.Metric37 rewrites AI drafts so they read naturally. Free AI detector, 1,500 words free.Try Metric37 →