🔖 Шаблон постановки задачи на REST API-метод для Confluence 🔖


Зачем нужен шаблон постановки задачи?
(Особенно для REST API)

1️⃣ Разработчики всегда понимают что и в каком месте искать в статье с требованиями.

2️⃣ Постановка задачи (требования) = Будущая статья в документацию.
Нет двойной работы.

3️⃣ Системный аналитик не упускает требования и всегда держит единую структуру документа.


Этих трёх пунктов достаточно, чтобы понять цель шаблона:

повысить качество постановок задач и документации 🙌

К посту добавила пример шаблона для Confluence.
Также в нашем блоге можно найти статью с пояснениями к нему.

#ResApiGa

🤖 8 уязвимостей в интеграции с Generative AI - чек-лист НФТ по безопасности для ТЗ 🤖

Когда вам придётся писать требования на разработку системы с AI-интеграциями, то НФТ по безопасности станут одними из главных.

Их важно учесть, чтобы:
✔️ спроектировать корректные алгоритмы работы системы и точки контроля
✔️ писать системные промпты, которые будут лежать "под капотом" системы
✔️ автоматизировать процессы пользователей без ошибок и неожиданных действий
✔️ защищать персональные данные, секреты и конфиденциальную информацию
✔️ настроить логирование, мониторинг и реакцию на инциденты, связанные с использованием AI

Собрала для вас чек-лист из 8 уязвимостей, которые надо учитывать в ТЗ и при проектировании сценариев в системах, где есть интеграции с AI 🤖

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

🔔🤖 Postman, Insomnia и AI-ассистент - доступ к записи открыт 🟠🟣🤖

Коллеги, всем зарегистрированным участникам доступ пришел на почту ещё вчера утром.

Если не нашли письмо или ещё не регистрировались:
🔗 Получить доступ

🗓 Запись будет доступна только до 5 ноября, 23:59 Мск. Успевайте посмотреть!

----------

P.S.
Огромная благодарность за вашу обратную связь! Всё вижу, всё читаю! 🫶

Roxel [01.11.2025]

Это очень практичный и очень полезный вебинар. Это практикум! Все материалы систематизированы, урок прошел на одном дыхании. Это магия! Спасибо борльшое, Екатерина! Вы самый крутой профессионал, который преподает в домене Системного анализа на русском языке! Вы - СУПЕР!

Julia [01.11.2025]

Впечатления о занятии: Большое спасибо за занятие! Очень много полезной информации и практических примеров. На мой взгляд Катя сейчас один из лучших лекторов по систиемному анализу.

Юлия [01.11.2025]

очень полезно, особенно про AI-ассистента

----------

P.S.S.
Вопросы? Пишите @getanalyst или info@getanalyst.ru

🔖 Получение данных через POST в REST API + кэширование: пример требований для Backend-разработчика 🔖

Вопрос с подвохом, который вы можете встретить на собеседовании:

Можно ли использовать метод POST для получения данных?

👉 Да, можно.



Метод POST в REST API изначально предназначен для отправки данных на сервер с целью их обработки и создания новых записей в БД.

В то же время его можно использовать для получения данных:

👉 1. Запросы с большим количеством фильтров
Когда необходимо реализовать большое количество фильтров для получения списка, то решение отправлять их все в URL запроса как query-параметры не лучшее, т.к. это делает URL очень длинным.

Это может вызвать проблемы с ограничениями на длину URL в некоторых веб-серверах или браузерах.

Кроме того, сложные и многочисленные параметры в URL могут затруднить читаемость и понимание запроса для других разработчиков и пользователей API.


👉 2. Асинхронные запросы на получение данных: комбинирование POST и GET



Подготовила для вас пример постановки задачи на Backend, который не соответствует концепции REST API и показывает, как работать с большим количеством фильтров на поиск 😱

POST /products/search - Поиск по каталогу продуктов

Что важного внутри:
▫️ алгоритм для API в микросервисной архитектуре
▫️ кэширование - базовые требования
▫️ фильтры и сортировки в JSON
▫️ пагинация в URL

Это антипаттерн проектирования REST API для получения данных из-за POST и его нежелательного кэширования, но его часто используют в реальной жизни 🙃

Такого насыщенного деталями примера больше нигде не найдёте в открытом доступе.

🔖 Обязательно сохраняйте этот новый образец требований по REST API в личный архив и поддержите пост ❤️🔥, если это то, что вам действительно актуально


#RestApiGA #FarmFreshGA

🦋 Редактирование через PUT: пример требований к REST API методу 🦋

Когда нужно сделать метод редактирования, возникает дилемма. В REST уместны два подхода.


1️⃣ PUT - полное изменение ресурса
На вход передаются все параметры объекта (ресурса), включая те, которые не меняются.

📍 Пример:
Хочу отредактировать только название товара.

✅ Как работать с PUT:
Передавать на вход вообще все параметры товара - название, описание, цена и т.д. Даже если я хочу поменять только название.

🙌 Как бывает в реальности:
Полную передачу параметров игнорируют и делают PUT, который работает по правилам PATCH.



2️⃣ PATCH - частичное изменение ресурса
На вход передаются только данные, которые нужно поменять.
Идеален для случаев, когда меняется статус (заблокировать пользователя, архивировать товар, отменить заказ и т.п.).

📍 Пример:
Хочу отредактировать только название товара.

✅ Как работать с PATCH:
В запросе отправляется только название товара.
Ничего лишнего.
Это позволяет экономить трафик.

🙌 Как бывает в реальности:
Используют PUT вместо PATCH, потому что так исторически сложилось 😄

📌 Как быть, если вы встретились с подобной задачей впервые?

Если проект действующий, то посмотрите какие методы уже используются для редактирования:
+ Все PUT? Выбирайте PUT
+ Все PATCH? Выбирайте PATCH
+ Есть и PUT, и PATCH? Или новый проект? Обдумать решение согласно концепции REST




Подготовила пример задачи на Backend, который показывает, как работать с редактированием через PUT:

PUT /products/{productId} - Редактировать

товар фермером/продавцом

Что важного внутри:
▫️ обоснование, почему PUT, а не PATCH
▫️ редактирование картинок у товара - отдельные методы
▫️ новый каталог seller-api на сервере (сравните URL с поиск товаров покупателями)
▫️ алгоритм для API в микросервисной архитектуре
▫️ обработка HTTP-401 и HTTP-403 в алгоритме (требования к реализации) и в примерах ответов

🔖 Новый образец требований по REST API (метод PUT) в ваш личный архив.


#RestApiGA #FarmFreshGA

📊 5 метрик мониторинга, которые решают 80% проблем 📊

Для многих аналитиков и разработчиков нефункциональные требования к системе — тёмный лес. Понятно, что «система должна работать быстро и надёжно», но вот какие именно цифры написать в ТЗ, какие метрики указать и как всё это потом проверять — часто остаётся загадкой.

Мониторинг — один из ключевых инструментов, связанных с архитектурой и инфраструктурой, который позволяет не на словах, а в реальности проверить, выполняются ли нефункциональные требования.

🔗 Статья к эпизоду


В эпизоде разбираем:
✅ что именно нужно мониторить на проекте,
✅ какие инструменты обычно настраивают,
✅ какие конкретные метрики и показатели можно и нужно писать в ТЗ.

После выпуска у вас будет структурированное понимание, какие цифры писать в НФТ и как измерять качество системы, а не просто «надеяться, что всё ок» 🙌


Эпизод доступен в:
⏯ Apple Podcast
⏯ Яндекс.Музыка
⏯ Telegram
⏯ Castbox
⏯ Звук
⏯ Spotify
⏯ RuTube
⏯ YouTube
⏯ VK Video


📚 База знаний GetAnalyst - здесь вы найдёте более 100 примеров задач, схем архитектуры и диаграмм. Всё самое важное для системных аналитиков и архитекторов!

🗓🤖 [17.11 в 19:00 Мск] Нейросети для проектирования БД и SQL-запросов 🤖

В следующий понедельник будем разбираться на практике, как эффективно использовать нейросети для проектирования БД и выполнения SQL-запросов.


🤖 Использование ChatGPT (и другие нейросети) для проектирования БД + SQL
🗓 17 ноября [пн]
🕘 19:00 - 21:30 МСК

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


✅ Занятие проводится в рамках подписки на практикумы по БД и SQL. Участи платное - от 1390 руб.
✅ Запись будет доступна после занятия.

🎁 Уже сейчас доступно занятие в записи по SQL, с практикой в реальной БД через DBeaver 😎


👉 План:
1. Знакомство с AI-инструментами и базовыми командами. Внедрение в работу системного аналитика.
2. Проектирование физической модели БД - PostgreSQL с использованием команд ChatGPT.
3. Автоматическая отрисовка ER-модели с использованием ChatGPT и дополнительных инструментов.
4. Создание реальной БД и SQL-запросы в DBeaver.


👉 В результате практикума:
✔️ Научитесь грамотно формулировать промпты для AI.
✔️ Получите связки инструментов, которые необходимы аналитикам для работы с базами данных.
✔️ Создадите свою СУБД через DBeaver и выполните SQL-запросы в ней.

По вопросам можно писать через сайт или @getanalyst 💬


------
👇👇👇
А если вам уже сейчас хочется узнать больше про использование нейросетей для работы, то рекомендую послушать подкаст
🎧 Полный гид по AI для системных аналитиков

🔖 84 термина по Архитектуре, которые важно знать Системному Аналитику 🔖

◻️ Общие архитектурные понятия
1. Архитектура системы
2. Компонент
3. Модуль
4. Подсистема
5. Сервис
6. Backend
7. Frontend
8. Web-приложение
9. Сайт
10. Desktop-приложение
11. Мобильное приложение
12. Виджет

🧱 Архитектурные стили и подходы
13. Монолитная архитектура
14. Модульный монолит
15. Сервис-ориентированная архитектура (SOA)
16. Микросервисы (MSA)
17. Событийно-ориентированная архитектура (EDA)
18. Слоистая архитектура
19. API Gateway
20. Хореография
21. Оркестрация
22. Service Registry and Discovery
23. Backend for Frontend (BFF)
24. Database-per-Service (БД на сервис)
25. CQRS (Command Query Responsibility Segregation)
26. Domain-Driven Design (DDD)
27. Event Storming
28. Чистая архитектура

🔗 Интеграция и взаимодействие компонентов
29. API (Application Programming Interface)
30. REST API
31. GraphQL
32. gRPC
33. SOAP
34. WebSocket
35. Синхронное взаимодействие
36. Асинхронное взаимодействие
37. Webhooks
38. Polling
39. Long Polling
40. Message Broker (Брокер сообщений)
41. Kafka
42. RabbitMQ
43. ESB (Enterprise Service Bus)

💾 Хранение данных
44. База данных (БД)
45. СУБД
46. Реляционные БД (PostgreSQL, SQLite, MySQL, Oracle и др.)
47. NoSQL БД (MongoDB, Redis и др.)
48. Файловое хранилище
49. Шардирование
50. Репликация
51. Кэширование

🔐 Безопасность
52. Authentication (Аутентификация)
53. Authorization (Авторизация)
54. SSO (Single Sign-On)
55. OAuth 2.0
56. JWT
57. Token
58. Bearer Token
59. Basic Authentication
60. Keycloak
61. TLS
62. HTTPS
63. WWS
64. Аудит

🖼 Нефункциональные требования (НФТ)
65. Масштабируемость
66. Доступность
67. Отказоустойчивость
68. Производительность
69. Сопровождаемость
70. Безопасность

⚙️ DevOps и инфраструктура
71. CI/CD (Continuous Integration / Continuous Delivery)
72. Балансировщик нагрузки (Load Balancer)
73. Docker
74. Kubernetes
75. Service Mesh
76. Мониторинг (Prometheus, Grafana, Zabbix и др.)
77. Логирование (ELK с Kibana, Loki + Grafana и др.)
78. Дашборды
79. Tracing
80. Health Check

📐 Проектирование и документация
81. UML Sequence Diagram
82. UML Activity Diagram
83. C4 Model (Context, Container, Component, Code)
84. Archimate
85. ERD (Entity-Relationship Diagram)
86. Нефункциональные требования (НФТ)
87. Архитектурные решения


📍 Сохрани себе — пригодится при знакомстве с архитектурой, микросервисами, API и подготовке к собеседованиям 😎


P.S. Есть что добавить? Пиши в комментарии!

#АрхитектураGA