Как описать микросервис 🤔
Принесла вам шаблон описания сервиса. Сохраняйте пост, чтобы не потерять или просто забирайте шаблон по ссылке. 📌Ключевым элементом в шаблоне является функция - атомарный кусок логики,запускаемый в результате срабатывания того или иного триггера.
Примером функции может быть логика обработки события, поступившего из брокера, API метод или какой-то процесс, запускаемый джобом по расписанию
Довольно детально получается, не всем зайдет. Но лично я, когда начала описывать в таком стиле, заметила целый ряд плюсов:
🟠отвечая на вопросы, всё чаще могу просто прислать ссылку 🟠за счет перекрестных ссылок со страниц описаний методов и бизнес-процессов в доке стало меньше дублирования 🟠стало понятнее, что именно надо описывать и где
Теперь видно, из каких именно функциональных кирпичиков сервисы состоят 🧱 ➖➖➖➖➖➖➖➖➖➖ Напоминаю про пост с шаблоном описания метода, который размещала ранее.
Как вам шаблон? Делитесь впечатлениями ⬇️
В этом посте были ссылки, но мы их удалили по правилам Сетки
· 25.09.2025
Если сервис использует бд, то в алгоритме работы придётся описывать маппинг из/в базу, а значит описание базы удобнее делать в алгоритме, чтобы всё было перед глазами, а не бегать по ссылкам.
Упущен блок нефункциональных требований. А и хер с ними😂
0
ответить
коммент скрыт — часть юзеров считает его токсичным или некорректным
коммент удалён