⚙️ Use Cases: обычные VS интеграционные ⚙️

Use Case — это:
✅ детализированные функциональные требования;
✅ описание того, как пользователь взаимодействует с системой для достижения определённой цели;
✅ сценарий, который показывает шаги, выполняемые пользователем и системой в процессе выполнения задачи;
✅ алгоритм работы системы.

Стандартный шаблон Use Case включает:
▪ Предусловие
▪ Роли пользователей
▪ Приложения и системы
▪ Входные данные
▪ Основной сценарий
▪ Обработка ошибок и альтернативные сценарии
▪ Ожидаемый результат

В случае интеграций, Use Case дополняется:
▪ техническими деталями по вызовам API методов, которые аналитику важно прописать в постановке задачи,
▪ а также маппингом данных.


Интеграции — это не просто "еще одна задача".
Это серьезная работа по анализу взаимосвязей БД + Функций + UI/UX + API нашей и внешних систем, который требует нашего опыта, внимания и профессионализма 🙌

Мини-книгу про отличия обычных Use Case от интеграционных прикрепила к посту 🤝

#ИнтеграцииGA

Предзапись на практическую программу Интеграции завершается в среду

🎓 Старт: 25 декабря 2024
🗓 Первая онлайн-встреча: 15 января 2025
🎁 До 18 декабря скидка + доп. обучение по БД в подарок

🔗 Подробности и регистрация

На проекте удаётся прожить самый настоящий опыт, со всеми “подводными камнями”, которые встречаются в реальной работе

В программе:
◽️ 10 живых онлайн-встреч
◽️ Работа над ОДНИМ проектом в течение всего обучения
◽️ Разбор всех этапов проектирования интеграций от А до Я на его примере
◽️ Возможность задать вопросы и получить обратную связь сразу

Ключевые темы:
🔸 определение точек интеграций в сложной системе,
🔸 REST API, GraphQL, SOAP API и другие способы интеграции систем,
🔸 работа в Postman,
🔸 архитектура систем, нотация C4,
🔸 интеграционные Use Case,
🔸 нотация UML,
🔸 маппинг данных,
🔹 ведение документации в Confluence,
🔹 создание и распределение задач на разработчиков.


Вопросы по обучению можно задать @getanalyst или на сайте.
Мы свяжемся с вами, проконсультируем по вопросам и актуальности программы для вас.

🔔 Открытый вебинар уже завтра: REST, GraphQL, gRPC 🔔

Встречаемся завтра на практике, в прямом эфире:

⚡️ Интеграции по REST, GraphQL и gRPC: знакомство через Postman
🗓 18 Декабря, в 19:00 Мск (ср)
🔗 ЗАРЕГИСТРИРОВАТЬСЯ

Подготовка:
1. Зарегистрируйтесь в Postman.
2. Если вы ни разу не пользовались Postman, попробуйте создать Workspace и коллекцию. Инструкция по Postman здесь. Всё остальное покажу 🤝
3. Откройте Postman перед началом занятия.

Рекомендую подключаться к эфиру с компьютера, т.к. будем вместе, в прямом эфире, тестировать API.

Эта практика - ваша возможность сделать огромный шаг в понимании работы с API и интеграциями!

Регистрируйтесь, чтобы не пропустить!

📕 Подборка материалов по REST API, GraphQL, gRPC 📕

Уже сегодня на онлайн-практике будем изучать все виды API с использованием Postman.

А пока предлагаю познакомиться с нашими дополнительными материалами к занятию и посмотреть их до/после практики, чтобы закрепить результат 👇


⚡ REST API (Representational State Transfer)
Использует HTTP-протокол и основывается на концепциях ресурсов и методов (GET, POST, PUT, PATCH, DELETE и другие).
Широко используется для веб-, мобильных приложений и микросервисной архитектуры.
🔗 Официальная документация
📚 Проектирование REST API: спорные вопросы с проектов и собеседований на системного аналитика (и не только)
📚 Postman: навык тестирования REST API за вечер
📚 Вопросы и ответы по REST API: собеседование на системного аналитика (подкаст)

Пример документации:
Wildberries


⚡ GraphQL
Позволяет клиенту запрашивать только те данные, которые ему необходимы, с помощью декларативного языка запросов.
Удобен для сложных приложений с изменяемыми потребностями в данных, для мобильных приложений и микросервисов с целью оптимизации трафика между клиентом и сервером, который реализует API.
🔗 Официальная документация
📚 GraphQL — знакомство на практике через Postman [пошаговая инструкция]

Пример документации:
Contentful


⚡ gRPC
Использует Protocol Buffers для сериализации данных и поддерживает как синхронные, так и асинхронные вызовы.
Эффективен для микросервисной архитектуры с высокими требованиями к производительности.
Очень много коллег, кто в новых проектах на микросервисной архитектуре его использует сразу, даже не рассматривая REST.
🔗 Официальная документация
📚 gRCP vs REST - что выбрать для проекта (подкаст + материалы)

Пример документации:
Dropbox от Google


#ИнтеграцииGA

🤖 UML-диаграмма для сценария интеграции за 3 минуты: ChatGPT+PlantUML 🤖


🔗 Статья с инструкцией - пошаговый гайд с картинками и примерами


Если вы знаете инструмент, в котором можно описать диаграмму через код, то на помощь в её разработке приходит Искусственный Интеллект.

ChatGPT - Искусственный Интеллект
PlantUML - Инструмент для описания любых диаграмм UML через код


Инструкция по созданию UML Sequence:

1️⃣ Открой ChatGPT и войди аккаунт

2️⃣ Выполни команду

Работай как опытный системный аналитик.
Сделай код для plantUML, чтобы создать UML Sequence диаграмму.
Не показывай альтернативные сценарии.

Сценарий:
<название сценария>

Пользователи и системы:
<участники сценария>

Описание сценария:
<описание Use Case>

Заполни название сценария и список участников (пользователи, фронтенды, бэкенды, внешние системы, БД).

Скопируй и вставь на место <описание Use Case> детализированный Use Case с описанием сценария интеграции.
Пример Use Case.

Отправь запрос к ChatGPT.

3️⃣ ChatGPT вернет в ответ код диаграммы для PlantUML

4️⃣ Вставь полученный код в PlantUML

5️⃣ Обязательно проверь и скорректируй результат:
5.1. Вручную поправь код по аналогии - это быстрее
5.2. Проси уточнения кода у ChatGPT дополнительными запросами


➕ Плюсы:
1. Диаграмма за 3+15 минут, с учетом проверки результатов.
2. Не надо писать код самому.
3. Легко делать правки, т.к. диаграмма через код, и при любых правках всё двигается автоматически.

➖ Минусы:
1. Интеграционный Use Case должен быть описан идеально. Без него диаграмму не сделать, либо будет много правок в придуманном ИИ варианте
2. ChatGPT делает ошибки и за ним надо вносить правки


🔗 Статья с инструкцией


Рекомендую использовать этот лайфхак только при знании и понимании нотации.
Для тех, кто только изучает UML, рекомендую использовать ИИ для проверок ваших результатов.


#ИнтеграцииGA

👩‍💻 Интеграционный API-метод: как это работает? 👩‍💻

Работая с задачами на интеграцию, важно помнить, что в процесс вовлечены сразу несколько частей системы:

▫️Frontend – пользовательский интерфейс. Он не всегда есть в интеграционных задачах, но если присутствует, то выполняет роль инициатора запросов.

▫️Backend – серверное приложение, которое отвечает за логику обработки данных, их проверку и взаимодействие с внешними системами.

▫️Внешняя система – источник или получатель данных, с которым взаимодействует наш Backend.

Для обеспечения безопасности большинство интеграций реализуется через Backend.
Для этого создают интеграционные API-методы.


👉 Интеграционный API-метод – это метод на стороне нашего Backend, который:
+ принимает запросы от Frontend-приложения;
+ взаимодействует с внешней системой для получения или записи данных;
+ реализует логику сопоставления (маппинга) и обработку данных.


Почему используется интеграционный API-метод, а не прямое обращение к внешней системе с Frontend?

✅ Централизованное хранение данных:
Backend является центром хранения актуальных данных. Все изменения, включая удаление задач, должны проходить через него, чтобы данные оставались актуальными.

✅ Безопасность:
Хранить секретные ключи на стороне Frontend небезопасно – они могут быть скомпрометированы (например, перехвачены через консоль браузера). Размещение ключей на Backend исключает этот риск.


Пример алгоритма работы интеграционного API-метода разобрала в мини-книге к посту 🤝

#ИнтеграцииGA

💫 Проектирование распределенных БД [23 декабря] 💫

Хотим напомнить вам про продвинутые практикумы по программе проектирование БД и SQL.


В понедельник буду вести занятие:

📚 Проектирование распределенных БД
🗓 23 декабря, 19:00 Мск
👩‍🏫 Екатерина Ананьева

🔗 Узнать подробности и записаться

План:
1. Базовые понятия архитектуры: сервис-ориентированная (SOA) и микросервисная (MSA).
2. Знакомство с проектом и выделение сущностей.
3. Определение логической и физической моделей БД с разбором примеров по проекту.
4. Практика. Фокус на проектировании физических моделей БД - PostgreSQL.
5. Обзор шаблона постановки задачи на разработчиков.

+ Сразу после записи на практику доступно последнее актуальное занятие по миграции данных между БД, чтобы сразу было что изучать.


Участие в занятии актуально для аналитиков, кто уже знаком с проектированием БД и хочет погружаться в работу с более сложными задачами 💪

Есть вопросы? Пишите нам в аккаунт @getanalyst или на сайте 👌

🥶 Ледяные ванны — мой главный антистресс года 🥶

Я не выношу холод.
Но в этом году я попробовала то, что раньше казалось невозможным — ледяные ванны.

Схема простая:
1. 20 минут прогрева в сауне до состояния "я таю" 🫠
2. Погружение в ледяную купель с водой 4-5'C 🥶
Но не на пару секунд и побежала греться. А на 3-10 минут. Спокойно сижу, как в обычной ванной.
3. И так 2-3 круга.

Делаю это минимум два раза в неделю уже пол года.

Сначала мой организм был в шоке.
Это мероприятие — добровольное погружение себя в режим стресса, борьбы и выживания.

Я начала это ради того, чтобы быть спокойнее в любой непонятной ситуации. Развивать стрессоустойчивость.
И знаете что? Это работает.

Ещё интереснее, кто оказался моими "коллегами" по холодным погружениям.
Успешные, обеспеченные люди делают это для заботы о своём здоровье. И спортсмены для восстановления.
Это было неожиданно и еще более вдохновляюще.

За пол года эффект невероятный.
Когда только начинала, могла выдержать минуту и думала "зачем я вообще здесь себя так мучаю?".
К концу года спокойно сижу 3-4 минуты и думаю о прекрасном. Если в специальных защитных ботинках для ног, то все 10 минут могу оставаться в ледяной воде.
Это прекрасно снимает напряжение после долгих часов за компьютером и рабочих переживаний.

У нас это называется cold plunge. Их начинают устанавливать во многих спортзалах.

Хотела сделать подборку локаций в Мск и Спб, но не нашла ничего подобного 😞
P.S. Ныряние в прорубь это не совсем то 😂 Когда ты в обстановке как в СПА, рядом с сауной и горячим джакузи, то оно как-то приятнее всё))

Если кто-то такое тоже практиковал и знает места, поделитесь с нами в комментариях.

А если будете путешествовать и увидите вариант сходить в Cold Plangue - пробуйте!
Это классное хобби для восстановления и стрессоустойчивости с нашей работой 🤩