Шаблон описания метода 💻
Многие спрашивали про шаблоны документации, так что буду постепенно делать посты на эту тему всё для вас! По ссылке можно посмотреть шаблон описания метода gateway-микросервиса, через который внешние потребители вызывают все другие сервисы системы.
Из-за этой специфики в шаблоне есть: ✔️Подробности авторизации ✔️Список потребителей ✔️Заявленная нагрузка ✔️ Документация по интеграции ✔️Ссылки на страницы других сервисов
Одним словом, шаблон сделан так, чтобы быть полезным не только нам, но и аналитикам смежной системы, с которой мы интегрируемся.
〰️〰️〰️〰️〰️〰️〰️〰️〰️〰️〰️ Давайте обсудим! Чего не хватает? Что кажется излишним? Как у вас?