🎃❤️ Всем привет-привет! Хочу начать неделю не с разбора метода PATCH в REST API, а с пожелания хорошего настроения и рассказа про свои выходные. Не так часто делюсь личным, но тут сейчас вся моя публичная жизнь. Почему бы и да?

Я всё еще медленно вкатываюсь в новую жизнь, и это мой второй Halloween в ней. Или даже третий, если считать с университетских времен в Калифорнии.

🎃 Это была моя первая настоящая Halloween-вечеринка! Ура! Красивые костюмы, невероятные декорации. Всё было не просто идеально, а великолепно! Много деталей и атрибутов праздника. Настоящий американский Halloween в частном доме. Танцы, общение, эмоции - живое.

Знаете голливудские фильмы с крутыми вечеринками? Именно так я себя здесь ощущаю. Я в кино! И этот день был подтверждением.

В том году я была на небольшой вечеринке, но это было другое, больше как домашний праздник. В этом году интернациональное "пати" на 50+ человек. Я искренне счастлива и благодарна своей подруге за организацию и приглашение. Спасибо ей за очередной крутой вклад в фильм о моей жизни ❤️

Я хочу в очередной раз напомнить вам о том, что выходные важны. И как бы упорно мы не старались быть лучшей версией себя - помните, важно заботиться о себе, беречь себя и своё здоровье, и давать хотя бы один полноценный день отдыха, без компьютера и желательно без телефона.

Я занимаюсь учебой в выходные, работаю, но всё же стараюсь сейчас стабильно. минимум 1 день в неделю, быть полностью оффлайн. Это важно.

Ну и в течение недели помним о том, что каждый час надо вставать с места и ходить 🙂

Желаю вам хорошей и продуктивной недели! Делитесь в комментариях, как вы провели эти выходные? Отмечали хэллоувин?)

P.S.
Этот блог - наше с вами общее дело в GetAnalyst. Вы тоже его участники и создатели.
❤️ - если хотим начинать понедельники с историй за прошедшую неделю, что делают IT-шники вне работы.
👍 - не обязательно, или даже не желательно.

📌Пример PATCH в REST API
Проектирование метода REST API "Изменение приоритета задачи"

🟢 Описание метода
Метод предназначен для изменения приоритета существующей задачи в системе TMS. Он позволяет пользователям переопределять важность задач после их создания, обеспечивая тем самым гибкость в управлении рабочими нагрузками и сроками.

Возможные значения приоритетов: minor, major, high, critical, blocker.


🟢 Логика работы (Алгоритм):

1. Пользователь или клиентское приложение делает запрос на изменение приоритета задачи, передавая новое значение.

2. Система валидирует запрос, проверяя наличие задачи с таким ID, права пользователя на выполнение данного действия и полученное значение статуса.

3. После успешной валидации система обновляет значение приоритета в базе данных.

4. После обновления система возвращает подтверждение об успешном изменении приоритета, возвращая обновленный объект задачи.


Обработка ошибок:
2А. Полученное значение статуса не соответствует справочнику. Вернуть текст ошибки “Неизвестный статус” с кодом HTTP-400.
…


🟢 Формат запросов и ответов:
Запрос: Для изменения приоритета задачи мы будем использовать HTTP-метод PATCH, поскольку он предназначен для частичного обновления ресурса.
PATCH /tasks/123

{
"priority": "critical"
}


Ответ: 👇👇👇👇👇

Ответ: Успешный ответ будет подтверждать, что приоритет был изменен. Система может вернуть обновленный ресурс в ответе.

HTTP-200 OK
Content-Type: application/json
{
"id": 123,
"title": "Задача №1",
"description": "Описание задачи",
"dueDate": "2023-11-01",
"priority": "critical", // обновленный приоритет
"status": "open",
"updatedAt": "2023-10-17T10:00:00Z" // дата обновления
}


И это неполная постановка задачи… 🙂

Вообще-то с помощью PATCH /tasks/123 можно поменять не только её приоритет, но и остальные параметры, такие как название, статус, описание и другие. В URL-метода не заложено слово “приоритет”, поэтому это общий метод на изменение задачи. Описание алгоритма, общее описание метода и список примеров стоит расширить. Так как на вход так же может быть передан объект:

{
"priority": "critical",
"description": "Описание задачи"
}

Метод должен отработать успешно, только если логика на изменение этих полей была запроектирована.

🧑‍💻Карьера системного аналитика: преподнесение навыка REST API в резюме и подборка вопросов с собеседований 🧑‍💻

Один из must have навыков для современного аналитика стало умение проектировать API. Давайте разберемся, как этот навык лучше всего представить в резюме и на что стоит быть готовым на собеседовании.

📌 Как преподносить навык REST API в резюме:

▫️Конкретизируйте ваш опыт: Не просто укажите "Знание REST API", но и опишите, как вы его использовали — например, "Разработка и документирование REST API для интеграции между CRM и ERP системами".

▫️Проекты: Если у вас были крупные проекты, связанные с интеграциями и API, укажите их. Это даст работодателю понять глубину вашего опыта.

▫️Инструменты: Упомяните, с какими инструментами (например, Postman, Swagger) вы работали в контексте REST API.


📌 Подборка вопросов с собеседований на системного аналитика по REST API:

▫️Расскажите о вашем опыте работы с RESTful API. С какими проблемами сталкивались и как решали? Приведите примеры.

▫️ Какие методы HTTP вы знаете?

▫️ В чем разница между POST и PUT?

▫️ Опишите стандартный процесс проектирования REST API на вашем последнем месте работы.

▫️ Как вы обеспечиваете безопасность API? Знакомы ли вы с OAuth?

▫️ Что такое идемпотентность и какие HTTP методы являются идемпотентными?

▫️ Как вы документируете API? Использовали ли вы инструменты автоматической генерации документации? Какие?

▫️ Как реализовать обработку большого объема данных через REST API?

▫️Как проектировать асинхронные запросы?

▫️ Можно ли передавать файлы через REST API? Как?

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

Сохраняйте подборку вопросов в шпаргалки, смотрите одно из наших видео про асинхронные запросы (звук плохой - суть важная).

Разбор ответов и опыт по этим вопросам я даю на практической программе - Дизайн REST API. Последний поток в этом году стартует уже 1 ноября!

Сохраняйте пост! Успехов!

🛡️ Безопасность в REST API: Три ключевых метода авторизации


Безопасность обмена данными уже давно играет первостепенную роль в проектировании приложений. В случае с проектированием REST API от выбора способа авторизации зависит конфиденциальность данных.

Есть три основных способа авторизации, которые мы разбираем на программе REST API:

⚪️ Basic Authentication (логин + пароль):
Простейший метод, при котором логин и пароль отправляются в заголовке запроса в формате Base64. Хоть это и базовый подход, без дополнительного SSL/TLS он является уязвимым.
Пример: МойСклад

⚪️ API-ключи (токены):
Эти уникальные идентификаторы позволяют приложениям получать доступ к API. Они обычно отправляются в заголовке запроса. Главный минус? Если ключ утек, его могут использовать злоумышленники. Хотя от этого можно защититься.
Пример: МойСклад (альтернативный способ к Basic)

⚪️ OAuth:
Самый современный и безопасный метод. OAuth позволяет пользователям давать приложениям ограниченный доступ к своим ресурсам без раскрытия своих учетных данных. Он сложен в понимании, если просто читать про него теорию. Но попробовав применить его на практике, понимание приходит!
Пример: vk


🔐 Помните, выбор метода авторизации должен соответствовать требованиям безопасности вашего приложения. В ваших руках безопасность пользовательских данных! Как системные аналитики вы влияете на решение вместе со специалистами по безопасности, архитекторами и backend-разработчиками.

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


Примеры:

🟡 При входе в приложение для редактирования фотографий, Вам предлагают воспользоваться учетной записью ВК/Яндекс/Mail.ru/Google, чтобы вы могли использовать эту учетную запись для входа, а также иметь легкий доступ к связанным с этой учетной записью фотографиям.

🟡 Сервисы для анализа активности в социальных сетях: При использовании сервисов для анализа вашей активности в социальных сетях (например, для определения наиболее популярных постов или получения статистики подписчиков), вам, возможно, потребуется предоставить этим сервисам доступ к вашим аккаунтам в соцсетях.

🟡 Приложения для фитнеса: Когда вы хотите синхронизировать данные о своей физической активности между различными фитнес-приложениями или устройствами, одно из приложений может запросить доступ к данным другого.

🟡 Приложения для учета расходов: Если вы используете приложение для учета личных финансов и хотите, чтобы оно автоматически импортировало информацию о ваших транзакциях из вашего банка, приложение будет запрашивать доступ к вашему банковскому аккаунту.


Но как это все работает с точки зрения безопасности? Ответ — OAuth 2.0.

🔍 Что такое OAuth 2.0?
Это стандартная процедура авторизации, которая позволяет пользователям безопасно делиться своими данными между различными приложениями.

Основное преимущество OAuth 2.0 в том, что пользователи не делятся своими учетными данными прямо с приложением, которому они предоставляют доступ.


🔄 Как это работает?
Представьте, что у вас есть приложение для фитнеса, и вы хотите передать его данные в приложение для планирования питания.

Вместо того чтобы вводить свой логин и пароль от фитнес-приложения в приложение планирования, вы просто даете разрешение на передачу определенных данных, используя OAuth 2.0.

Таким образом, ваши личные данные остаются в безопасности и ваши логин и пароль не переданы разработчикам приложения по питанию.


🎭 Ключевые роли в OAuth 2.0 на примере с приложением по фитнесу

🔹 Владелец ресурса: это пользователь, который предоставляет доступ к своим данным.
▫️ Пользователь приложения фитнеса, который регистрируется в приложении по питанию.

🔹Клиент: приложение, запрашивающее доступ к данным.
▫️ Приложение питания.

🔹Сервер авторизации: выдает токены доступа клиенту после успешной авторизации.
▫️ Это на стороне приложения фитнеса.

Продолжим завтра 👇

Продолжение про OAuth👇👇👇

🔐 Токены доступа и обновления в OAuth:
Токен доступа (access_token) — это ваш "ключ" к данным. Он имеет ограниченный срок действия и может быть обновлен с помощью токена обновления (refresh_token), который обычно действует дольше.


✅ Преимущества OAuth 2.0:
Простой и понятный процесс авторизации.
Возможность выбора между различными типами токенов.
Повышенная безопасность и контроль пользователей над их данными.


🛡 Лучшие практики при работе с OAuth 2.0:
- Используйте токены доступа с коротким сроком действия.
- Ограничивайте область действия токена.
- Защитите свое приложение от распространенных атак.
- Обеспечьте безопасное хранение и передачу токенов.
- Позволяйте пользователям отзывать доступ к их данным.
- Предоставляйте понятную документацию.
- Следуя этим принципам и понимая основы OAuth 2.0, вы сможете обеспечивать высокий уровень безопасности при интеграции с различными API и улучшать UX в ваших системах.

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

В новом потоке по Дизайну REST API я вижу как бизнес-, так и системных аналитиков. Есть ведущие специалисты, которые структурируют знания и осваивают принципы организации работы системных аналитиков для своих команд. Из опыта - вопросы от них всегда ТОП и помогают сделать занятия интереснее ❤️

Основные цели:
👍 сменить работу и/или повысить доход,
👍 перейти в системный анализ
👍 получить практический опыт по дизайну REST API, чтобы пополнить портфолио (+++ моя цель, чтобы на собеседовании вы рассказывали про наш проект, который ведем в ходе курса, а не про "сферического коня в вакууме")

Сегодня открываем первые модули и начинаем знакомство с проектом. Спасибо вам за доверие. Ваши цели = мои цели. Будем идти к ним вместе!

P.S. Первый вебинар 8 ноября в 19Мск. А сейчас бегом смотреть предобучение, если еще не начали! 😉

Дмитрий 👍

🎯 ТОП-инструменты для системного аналитика: Postman и Swagger! 🎯

Эти инструменты незаменимы для системных аналитиков и разработчиков, которые работают в Backend-командах и разрабатывают API.

🔍 Postman – это мощный инструмент для тестирования API. С его помощью аналитики могут:
🔅 проверять ответы API на различные запросы, сверять документацию и реальность, лучше понимать, что “под капотом” системы;
🔅создавать и сохранять наборы тестовых запросов для разработчиков;
🔅имитировать разные ситуации, чтобы убедиться в стабильности системы, помогая тестировщикам или продумывая вместе с ними как обработать очередную найденную ошибку.

Пример реального использования: Компания разрабатывает интеграцию с системой доставки. Системный аналитик использует Postman для проверки корректности работы всех функций API системы доставки, что позволяет глубже понимать, как работает внешняя система, лучше описывать технический сценарий интеграции и понимать все подводные камни ее проектирования.


📑 Swagger – это фреймворк для проектирования и документирования API. С его помощью можно:
🔅 визуализировать структуру API;
🔅 создавать интерактивную документацию, доступную для команды разработчиков;
🔅 упростить процесс интеграции для сторонних разработчиков.

Пример использования: Компания предоставляет свой API партнерам. Благодаря документации на Swagger, партнеры без проблем интегрируются и начинают использовать сервис, что повышает уровень удовлетворенности и способствует расширению партнерской сети.
P.S.Это же можно делать и в Postman.


Если вы системный аналитик и еще не работаете с этими инструментами, то рекомендую начинать делать первые шаги уже сейчас. Ведь это не просто модные слова, это реальные навыки работы в процессе работы с задачами на Backend и интеграциями, которые повысят вашу ценность на рынке труда!

Как обнимать своих демонов 😈

Знаете, есть одна тема, о которой мы, системные аналитики, не любим говорить вслух. Страх перемен: новый проект, новая компания, страшные собеседования, новые люди, аааа…. Понимаю, что многие из вас уже приготовились листнуть дальше, думая: "Опять эта психология". Но подождите минутку!

Было такое, что волнительно было предложить что-то новое, не зная, как отреагируют коллеги? Или страх, что ваше предложение приведет к ошибкам? Я тоже проходила через это. 😓

Почему мы боимся? 😱

Страх — это наш внутренний механизм защиты. Когда мы что-то меняем, наш мозг видит это как угрозу комфорту. Но изменения — это рост! Иногда нам просто нужно напомнить себе, что мы способны на многое.

Как преодолевать страхи перемен:

💡Общение: Говорите с коллегами. Поделитесь своими опасениями. Вероятно, они тоже чувствовали так же и могут поделиться опытом.
💡Обучение: Чем больше вы знаете, тем увереннее чувствуете себя. Не стесняйтесь задавать вопросы и углубляться в тему.
💡Маленькие шаги: Начните с маленьких изменений. Постепенно у вас появится уверенность для более крупных задач.
💡Принятие: Примите тот факт, что ошибки случаются. Главное — это возможность учиться на них.
💡Помните о поддержке! Да, иногда проекты и системы кажутся сложными и пугающими. Но помните, что вы не одни. У вас есть команда разработчиков, менеджеры, коллеги аналитики. Мы все в этом вместе, и вместе мы можем справиться с любым вызовом!

Не бойтесь перемен! Ведь каждое изменение — это шаг вперед, новый опыт и возможность стать еще лучше 💪🌱

А у вас были моменты, когда страх перед изменениями останавливал вас? Как вы с ним справились? Делитесь в комментариях!

🧡 Postman: функции, о которых должен знать каждый 🧡

Знакомство с Postman обычно начинается с его базовых возможностей для тестирования API, но сколько же ещё открытий приготовила эта платформа!

Хочу поделиться с вами фишками в Postman, которые могут упростить и улучшить ваш рабочий процесс 🤩

1️⃣ Postman Echo:
Это ваш личный тренажер для тестирования REST-клиентов, позволяющий отправлять запросы и получать зеркальный ответ, что идеально для проверки отправляемых данных.

2️⃣ Postman Visualizer:
Превратите данные вашего ответа на запрос в наглядные визуализации с помощью HTML, CSS и JavaScript. Импортируйте любимые библиотеки для построения графиков и создавайте персонализированные отчеты прямо в Postman.

3️⃣ Контроль рабочих процессов - Workflow Control:
Организуйте логику выполнения запросов в коллекции, используя метод postman.setNextRequest для программного определения последовательности запросов.

4️⃣ Функции совместной работы:
Совместная работа в Postman достигла нового уровня с введением комментариев, веток, запросов на включение изменений и других функций. Работайте над API вместе с командой, делитесь результатами и делайте кросс-ревью!

5️⃣ Информация на уровне коллекции:
Максимально переиспользуйте переменные, скрипты и учетные данные аутентификации, устанавливая их на уровне коллекции. Сократите дублирование усилий и упростите обслуживание своих коллекций.

6️⃣ Документация: Делайте вашу документацию неповторимой, добавляя изображения и гифки благодаря поддержке синтаксиса Markdown.

Эти функции - лишь вершина айсберга того, что предлагает Postman. Начните использовать их сегодня, чтобы увидеть, как они могут трансформировать вашу работу с API! 🚀

Какие функции Postman кажутся вам наиболее полезными? Делитесь в комментариях 🙂

1️⃣ «Я САМ!»
Специалист долго сидит над задачей и блуждает в догадках, не обращается за помощью и в результате выдаёт неверный результат.

Как пофиксить: Никто не осудит вас за то, что вы обратились за помощью. Не стесняйтесь задавать вопросы, уточнять и переспрашивать — вы начинающий специалист и желание разобраться в предметной области только положительно скажется на вашем становлении в сфере IT.


2️⃣ Не прорабатаны негативные и альтернативные сценарии
Аналитик учитывает только основные кейсы, но не берёт во внимание, что что-то может пойти не так. А в жизни обязательно что-то пойдёт не так! И логику на такие случаи тоже необходимо проектировать.

Как пофиксить: Изучите опыт пользователей, сформулируйте полную картину текущих процессов. В конце концов, можно обратиться к тестировщикам и узнать, какие варианты возможны внутри выполнения функции.


3️⃣ Верит предложенным решениям заказчика
Заказчик не всегда понимает причину, но всегда видит последствия. И зачастую в формулировке требований от него озвучено лечение симптома («Поправьте в базе!»), а не корневой причины («А почему в базе сформировались неверные данные?»).

Как пофиксить: Уточняйте у заказчика, какую проблему необходимо решить. Используйте технику «Пять почему» для выяснения корневой проблемы.


4️⃣ Не задаёт уточняющие вопросы после интервью
Как итог — начинает додумывать требования.

Как пофиксить: В конце интервью предупреждайте, что позже могут появиться уточняющие вопросы, которые можно задавать письменно или звонить.


5️⃣ «Незаметное» согласование
Отправка требований на согласование на почту без дополнительного уведомления или вообще отсутствие согласования — это сложность, которая скажется на длительности поставки решения и даже на его правильности.

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


6️⃣ Хаос в документации
Вся документация по проекту хранится в разных местах и форматах, а документация от проекта к проекту отличается по ключевым блокам. Отсутствие шаблона усложняет быстрое погружение как проектной команды, так и ревьюеров. Также существует риск упускать важные описания процессов, что может повлиять на качество решения.

Как пофиксить: попросить у наставника шаблоны описания документации, а если их нет — использовать общепринятые шаблоны (Вигерс, ГОСТ и так далее), сформируйте собственные чек-листы по подготовке документов, в которых будут учтены обязательные блоки и их порядок. Впоследствии можно прогонять каждую задачу по этому чек-листу.


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

😱 Теперь ChatGPT точно заменит IT-аналитиков! Он сможет сам делать любые постановки задач! Или нет? Или да? 🤔 #chatgpt_getanalyst

Сегодня открыла ChatGPT на платном тарифе, который мы вместе с вами в оформили в прямом эфире в марте, чтобы не было сбоев во время онлайн-трансляции и практики.

На платном тарифе с ChatGPT 4 сегодня все получили сообщение:

🇺🇸 ChatGPT can now browse the web, analyze data, and generate images.
These capabilities are now built into GPT-4, no need to select them. Available for Plus users.
🇷🇺 ChatGPT теперь может просматривать веб-страницы, анализировать данные и создавать изображения. Эти возможности теперь встроены в GPT-4, выбирать их не нужно. Доступно для пользователей Plus.


Что это значит для сферы системного и бизнес-анализа в IT:

❓ ChatGPT 4 и раньше умел писать требования, а теперь он сможет сделать их еще лучше, за счет возможности ссылаться на работающие сейчас сайты для их анализа и получения актуальной информации, без ручного ввода.
Он сможет анализировать длинные тексты с веб-страниц и больше не нужно будет копировать в него информацию для анализа: например, длинные тексты законов.
До этого нужно было копировать информацию для анализа вручную, и в чате были ограничения на длину входящего запроса. Временные затраты на аналитику были большие. Также нужно было аккуратно структурировать информацию и давать определенные команды на анализ длинных статей и документов по частям.

❓ ChatGPT 4 научился рисовать диаграммы: UML, ER, BPMN, C4 и другие. Это позволит дополнять требования диаграммами и получается, что работа аналитика почти не нужна.
До этого рисование ChatGPT не поддерживал и нужно было использовать другие нейросети, такие как Midjourney. Но их нельзя было использовать для создания диаграмм.

❓ Разработка прототипов экранных форм теперь занимает меньше 5 минут и ChatGPT всё делает сам. Дизайнеров можно не привлекать и аналитик может полностью отвечать за разработку дизайна.


Разбираться с обновлениями? 🔥

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

⭕️ Все результаты, которые выдает ChatGPT, нужно проверять. И без наличия специализированных знаний и навыков это сделать невозможно. Да, какие-то факты можно проверить через Google, но всё же то, что он выдаёт, должно подвергаться переработке специалистами.

⭕️ ChatGPT невозможно пользоваться для экономии времени, не зная связки команд, которые помогут максимально точно получать информацию и ускорять работу. Без знания команд и без обладания навыками и опытом в профессии, его использование превращается в общение с Google, который выдает уникальную информацию, еще и с ошибками.

⭕️ ChatGPT - помощник специалистов, которые хорошо владеют теоретической и практической базой в своей работе. Заменить специалистов он всё ещё не может.


Неважно о каких профессиях мы говорим: системные и бизнес-аналитики, программисты, тестировщики, финансисты, маркетологи, копирайтеры. Пока искусственному интеллекту нельзя доверять на 100%. Он сам об этом предупреждает и для чувствительной информации предлагает делать перепроверку самостоятельно, через привычные нам Google / Yandex / другие поисковики.

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

#chatgpt_getanalyst