Предлагаю отказаться от Confluence и всех других инструментов для документирования.

Давайте описывать требования к системам и ставить задачи для разрабтчиков на бумаге для повышения безопасности и избежания кибератак. Сразу после завершения работы с проектированием собирайте все свои А4 и отправляйте почтой на соответствующего разработчика. Когда он сделает коммит в гите, пусть пересылает задачу почтой на тестировщика.

Документация должна быть в единственном экземпляре. Копирование запрещено.

Теперь каждый системный аналитик будет получать огромные пачки бумажных документов для решения задач, и мы с нетерпением ждем, когда вы научитесь использовать современные инструменты, такие как карандаши и бумажные листы. От ChatGPT тоже отказываемся. А то он все узнает и расскажет другим 🤭

REST API является одним из самых важных и популярных инструментов в IT. Он широко используется в западных компаниях для создания веб-сервисов, мобильных приложений, интеграционных платформ и других IT-решений.

Если мы говорим о статистике, то в 2022 году REST API продолжает оставаться на вершине популярности в сравнении с другими видами API, такими как SOAP API или RPC. Согласно исследованию, проведенному в 2022 году, более 75% IT-компаний выбрали REST API для своих проектов.

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

Если мы говорим о примерах западных компаний, использующих REST API, то здесь можно назвать такие компании, как Amazon, Facebook, Google, Twitter и многие другие.

Например, Facebook использует REST API для своих сервисов, таких как Messenger и Instagram, а Amazon использует REST API для своих веб-сервисов AWS.

Чтобы начать самостоятельно разбираться с REST API, рекомендую попробовать посмотреть открытые сервисы и потестировать их самостоятельно через Postman.
Пример сервиса и краткое руководство можно получить в актуальном "REST API" моего instagram. запрещенного в РФ.

Доброе утро!
Готовы к практике на этой неделе?

Будем разбирать:
• задачу проектирования REST API с нуля,
• документирование в Postman,
• создание Mock-сервера для тестирования API.

Бесплатный онлайн-практикум
🟢 5 главных принципов дизайна REST API
👉 Регистрируйтесь по ссылке

Улучшайте свои навыки в системном анализе и получайте новый кейс в копилку уже в эту среду!

Время интересных историй...

На одном из проектов тим-лид разработки жаловался мне на боль с проектированием REST API. Это медицинская информационная система. Аналитик, который работает над проектом, случайно выбрал неправильный метод для передачи личной информации пациентов - POST вместо PUT. Это решение могло создать проблемы со стороны безопасности, потому что метод POST не обеспечивает защиты данных. И это только одна из ошибок. Жаловался он на нового коллегу несколько раз.

Объяснили аналитику, что нужно использовать более безопасный метод PUT для передачи чувствительной информации, он исправил ошибку и все было ок. А тим-лиду выдала рекомендаций на будущее, чтобы коллеги больше не расстаивали его.

Я всегда рекомендую компаниям внедрять корпоративные гайды по дизайну REST API, которые будут раскрывать правильные подходы к проектированию, внедренные в ней. Они позволяют избегать ошибок в целом и правильно выбирать регения аналитикам и разработчикам при проектировании.

Продолжение про безопасность POST и PUT совсем скоро 👇

ChatGPT работает* 🤨

В декабре 2022, в тестовом режиме, нам представили искусственный интеллект. И начался "хайп".

Море статей, постов и рекламы:
✖️ Дизайнеры больше не нужны, искусственный интеллект нарисует все
✖️ Программистов заменит ChatGPT, который пишет 300 строк кода в минуту
✖️ Компании увольняют сотрудников и вместо них теперь используют ChatGPT
И все в этом направлении. Видели?

Технологии захватывают мир и надо быть в тренде. Это нормально. Как только я узнала про ChatGPT, то сразу же начала внедрять его в свою работу. Достаточно много успешных решений с его помощью я сейчас получаю. Но. Есть нюансы.

На вебинарах в школе, на воркшопах, на текущих программах обучения я стараюсь показать, где можно использовать ChatGPT. Сразу после того, как научу работать без него. Готовлю prompts - команды. Есть последовательности команд для решения конкретных задач. Есть задачи, в которых ChatGPT применять совсем не стоит.

Итак. Что вы должны знать про ChatGPT 3-4-5... :

1. Информация, которой оперирует ChatGPT 4 и младше - все, что было в сети Интернет до 2021 года.
Поэтому, например, если вам нужно получить актуальную инструкцию по настройке и использованию системы, и вы явно не видите кнопок, которые он предлагает, то используйте команду:
"Это не актуально. Дай актуальную информацию на 2023 год".
После этого он даст нормальный ответ. Но! Было и такое, что он не мог дать решения. Настроить интеграцию с платежной системой Stripe он смог, но с ошибками. Пришлось включить критическое мышление и исследовательский опыт, чтобы я смогла довести задачу до конца.

2. ChatGPT дает идеи, но не всегда может дать готовое решение
При разработке ТЗ на систему в формате Use Cases пришлось дать ему достаточно много информации о проекте, чтобы он сделал ТЗ. Задание правильного контекста важно.
Но, что выбесило, он иногда теряет этот контекст. Когда слишком много сообщений в одном чате, ему надо напоминать о том, чтобы он вспомнил про предыдущие сообщения.
Научиться работать с контекстом в нем очень важно.
Результат, который он дает, нужно подвергать ревью. Идей он дает много, но не все рабочие!
На самом деле у каждого из нас теперь есть junior-аналитик от которого надо принимать задачи.
Спасибо ему, что ускоряет написание ТЗ, исследование и описание процессов, но проверять за ним нужно все)) В слепую сделать ctrl+c и ctrl+v не получится

3. Проверяйте ссылки
Это было забавно, когда он давал мне ссылки на несуществующую API-документацию. Или битые ссылки на ресурсы. И ладно, когда речь идет о малоизвестной системе. Но битые ссылки на API популярнейшего Instagram - это забавно, и это тоже случилось, когда я искала для вас примеры GraphQL-запросов на тестирование.
Опыт показал мне, что при попытках запрашивать у него источники информации или ссылки на API-докуменацию, он выдает устаревшие URL из своей памяти.
Так что возвращаемся к п.1 - судя по всему внутри много "закэшировано" и надо ему напоминать "Дай актуальное на 2023", если что-то не работает.
Так что обязательно проверяйте ссылки!

4. ChatGPT придумывает 🤭
...

Продолжаем обзор? 🔥

Уже зарегистрировались на онлайн-практикум завтра?

🔑 5 принципов дизайна REST API

В программе:
• создание методов REST API с нуля,
• погружение в фишки Postman,
• создание Mock-сервера.

Путь к интересным проектам начинается здесь!

👉 Регистрация по ссылке

Уже через 3 часа! Онлайн-практикум с Екатериной Ананьевой!

📹 5 главных принципов дизайна REST API
⏰ 19:00 - 21:00 Мск

Ссылку на трансляцию пришлем в канал за 15 минут до начала.

Заканчиваем теорию по кодам ошибок REST API и идем в Postman 🚀

Доброго утра и дня! Что вчера было? 🔥🔥🔥

1. Сначала я познакомила ребят с задачей, быстро собрали вводные по которым можно делать дизайн API-методов

2. Дала подробную вводную по тому, что из себя представляет REST API, и как делать дизайн методов. А потом Сергей Глаголев подробно рассказал про JSON-ы и как работать с HTTP-кодами ошибок.
В ходе разбора теории сразу же получилось сделать акцент на 5 главных принципах дизайна REST API.
Из крутого - я очень признательна вам за активность во время вебинара и Ваши вопросы!
Разбирали такие мелочи в создании URL как:
👉 эндроинт называть правильно /user или /users
👉 когда HTTP-202 код ответа нужен
👉 почему camelCase в JSON и не стоит использовать - и _
Этот контент появляется на ходу благодаря вам, все уточнения!
Практиковались делать JSON-ы в
http://jsoneditoronline.com
notepad++
https://www.jetbrains.com/idea/

3. Пошли в Postman и тут было самое интересное.
Я дала небольшую ввводную по тому как начать им пользоваться и создать свои первые Workspace, про их назначение, про назначение коллекций.
Затем Сергей разбирал супер-крутые фишки Postman:
👉 как с помощью спецификации OpenAPI делать документацию в Postman
👉 почему мы не начали сразу описывать запросы в JSON и работать через коллекцию, а выбрали папку APIs и работали в ней для документирования структуры API
👉 настроили переменные окружения
👉 сделали свой собственный mock-сервер, который делает дизайн API рабочим без единой строки кода от разработчиков!
👉 обсудили про генерации программного кода для логики приложения на основе OpenAPI специфмкации от аналитиков
👉 Другие возможности постман

На выходе с практикума у ребят остались:
🔑 Пошаговая инструкция по работе с Postman для создания коллекции запросов и mock-сервера из openAPI
🔑 Готовый шаблон OpenAPI спецификации для Postman
🔑 Результаты собственной работы
🔑 Знания по REST API
🔑 Опыт!

Вау? Вау! Спасибо вам за вовлеченность, а Сергею за топовые фишки Postman! Давайте поблагодарим его за крутой контент для нас!!! 🔥❤️

P.S. Про повторы напишу

Для тех, кто только-только начинает работу с Postman, у меня есть прекрасная запись Postman: навык тестирования REST API за вечер!

Погружайтесь в практику 😉

3 страха, которые губят специалистов

😒 Неуверенность в себе и своих знаниях.
😒 Боязнь не справиться с задачей и сделать ошибку.
😒 Беспокойство, что не будет возможности применить новые знания.

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

▪️ Чтобы преодолеть тревогу и продолжить развиваться, важно использовать свои страхи, как точки роста.
Участвуйте в проектах, которые вызывают неуверенность, чтобы развить уверенность и выйти за пределы зоны комфорта.

▪️ Принимайте ошибки, как часть процесса обучения.
Именно ошибки мозг воспринимает как слабые места и направляет силы туда, чтобы научиться избегать их в будущем.

▪️ Постоянно изучайте новые технологии и инструменты анализа данных.
Например, сейчас актуально осваивать AI (ChatGPT).

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

▪️ Ищите возможности для профессионального развития: книги, конференции, курсы обучения, семинары, вебинары, работа с наставником.

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

Попробуйте относиться к себе, как к самому крутому и важному проекту в жизни ❤
Пропишите стратегию и план развития. Отмечайте прогресс.

Поверьте, когда посмотрите на себя со стороны, увидите сколько уже вложено, то уверенности в себе станет гораздо больше 💎

Я всегда спрашиваю: какая цель?

И вот что рассказывали мне в GetAnalyst в октябре:
◾️Хочется сменить проект, но на текущем месте работы нет возможности получить нужный опыт
◾️Ничего не знаю про REST API. Хочу освоить, чтобы меня повысили
◾️Структурировать знания и пополнить резюме новыми навыками
◾️Необходимо углубленное понимание как проектировать дизайн REST API
◾️Освоить новые инструменты: Postman и Swagger

🏢 Компании выбрают обучение для своих сотрудников, чтобы сохранить их внутри компании за счет роста, повысить качество работы, внедрить корпоративную культуру по разработке REST API и снизить количество ошибок разработки, которые влияют на стоимость проектов.

Моя цель - доводить вас до результата. Поэтому любое обучение я начинаю с постановки целей.

Дизйн REST API — это продвинутый навык для опытных аналитиков, для junior-разработчиков. Глубокое понимание этой темы помогает лучше разобраться с архитектурой приложений, Backend и Frontend, как мобильные приложения и сайты общаются с сервером, как получать данные из БД и отображать их пользователям, интеграции между системами во всех возможных комбинациях.

REST API добавляет в резюме не только навык "REST API", но и следом подтягиваются "JSON", "Понимание архитектуры приложений на базовом уровне", "Postman", "Swagger", "OpenAPI".

Этот навык про подходы к проектированию, про архитектурный стиль. Особенность освоения в том, что нет одного правильного решения для задачи - их много. И их мы познаем через опыт.

Можно разобраться с проектированием REST API самостоятельно. В среднем на самостоятельное освоение уходит от 6 месяцев до 1 года. И все нюансы всплывают только когда начинаешь делать практику.

Я приглашаю вас разобраться с этим навыком за 2 месяца вместе со мной, в GetAnalyst:

🎓 Дизайн REST API, 18 апреля
🟢 Информация и запись по ссылке
Следующий поток в августе-сентябре

Профессиональный рост и интересные проекты начинаются с обучения. Делайте шаги вперед в своем развитии, любыми способами. У вас все получится! 🚀

Не успели узнать про:
• создание методов REST API с нуля,
• погружение в фишки Postman с документированием по OpenAPI,
• создание Mock-сервера?

Тогда ждем вас:
🗓 8 апреля (сб) в 15:00 (Мск)

Регистрируйтесь и приходите на повтор практикума:
🔑 5 принципов дизайна REST API
👉 Регистрация по ссылке

Сможете пересмотреть его и повторить то, что мы делали в эфире еще раз. Было очень много крутой информации! Полезно посмотреть второй раз и закрепить результат!

Когда впервые сталкиваешься с задачей проектирования REST API, особенно имея опыт работы с проектированием интеграций, то кажется, что это просто.

Но на деле можно столкнуться со следующими проблемами:

✖️ В одном месте эндпоинты /user, а в другом /documents. А как правильно?
✖️ В одном месте метод называется POST /createDocument, а в другом POST /user
✖️ А почему у нас в API все методы POST
✖️ Для метода на изменение данных выбрать PUT или PATCH?
✖️ А мы тут удалить документ из списка хотим. На экране его скроем, а в базе оставим. Что брать? PUT, PATCH или DELETE для API?
✖️ А в JSON мы делаем "userId" или "user_id" или "user-id"?
✖️ А если у нас пустой список, то возвращаем [] или HTTP-404? И вообще в каком формате у нас ошибки?

И это лишь малая часть вопросов при разработке дизайна REST API. Нюансов много. И вариантов решений всегда несколько.

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

Чтобы разработать гайд, я начала с того, что изучила лучшие практики дизайна API и уже существующие API на проекте. Со всеми этими знаниями я начала разрабатывать его. Гайд по дизайну REST API включал в себя понятные правила, которые помогали определить структуру запросов и ответов. Например, рекомендации по именованию ресурсов, выбору типов методов и кодов ошибок.

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

Создание гайда по дизайну REST API помогает стандартизировать процесс проектирования. Каждый разработчик может использовать гайд как руководство, что сокращает время на обсуждение вопросов и принятие решений. Гайд также помогает новым членам команды быстрее освоиться и начать работать с проектированием API.

Я считаю, что гайд по дизайну API - неотъемлемая часть процесса разработки. И я помогаю командам и компаниям его прорабатывать, а также делюсь этими знаниями со своими учениками.

Продолжим про подводные камни ChatGPT 🤖

4. ChatGPT придумывает 🤭
Хи-хи, ха-ха. Но я столкнулась с неприятной ситуацией. Я на пресэиле проекта радовалась, что у платформы, с которой надо интегрироваться, есть REST API. В гугле не могла найти, а ChatGPT нашел.

Когда запрашивала ссылку на ресурс, откуда ChatGPT берет API-документацию, то он вел меня на реальный сайт разработчика платформы. Но с ходу нужную API-документацию найти не могла, т.к. там много-много C# кода и других деталей. Сайт этот видела раньше, своим первичным анализом REST не находила.

Проверила API-документации от ChatGPT, увидела, что всех данных хватает, и их даже больше, чем нужно. Про авторизацию инстукцию запросила, где API-ключ получить. Все было правдоподобно. И... Когда начала тестировать через Postman, оказалось, что никакого REST API на самом деле нет. Тех поддержка позже подтвердила.

Все ок, мы нашли другой путь интеграции, спасибо команде, с которой мы работаем, но эта ситуация была бы не очень, если бы других путей не было.


5. Невозможно установить источник информации
В случае с API-документацией ChatGPT дал мне ссылку на сайт разработчика. Хотя по факту документации на нем не было.

Чуть позже я была шокирована выдаваемой информацией по проектированию. Каждый раз, получая от ChatGPT спорную информацию, которая не бьется с моим опытом, приходилось идти в Google. И не было источников данных - не могла найти их, т.к. он перефразирует все. Он должен оперировать данными из сети Интернет. Но какими, как он собирает результат?
Его "креативность" не позволяет проверить текст на правду-ложь.

Проверить, насколько правдивые данные он выдал, можно только командой "Это неверно, это выглядит как ошибка. Откуда такие данные?". Он либо подтвержит, что ошибся. Либо усомнится в своем ответе :) Говорят.ю его переучивали уже на 1+1=3.

Постмотрите на пост про безопасность REST и комментарии к нему. Это был один из тестов, когда я использовала его в помощь для ведения канала. Придумал интересно, как просила, но не правду. По факту HTTPS и SSL/TLS обеспечивают шифрование. Методы REST ни на что не влияют. Но ChatGPT придумал иначе. В конечном счете подтверждения нет.
Есть шанс, что если ChatGPT выдает 10 полезных ответов, а потом присылает ошибку, то мы даже не заметим ее. Так работает со всеми источниками информации. Наш мозг и поведение так устроены. Мы быстро заучиваем сценарии, быстро привыкаем к удобствам. И нам тяжело от них отказываться.
Чтобы увидеть некоторые ошибки проектирования ChatGPT, должен быть большой опыт.

*С описанием бизнес-процессов, Use Cases, User Story, UML и BPMN, работой по алгоритму, он справляется хорошо: явно видно, к чему приложить руку на доработку. А вот в моментах с техническим проектированием. при отсутствии должного опыта, ошибку вам не распознать


6. Машинный текст. Мертвый язык
Не буду много комментировать. Но когда я запрашиваю у него помощь с текстом для поста или для ТЗ, то все равно переписываю. Не всегда мой лайфхак со вставкой prompt "в стиле + "мой текст" " срабатывает.


7. В маркетинговом бизнесе мы приняли решение запретить использовать ChatGPT для генерации текстов
Соучредитель сказал: мы не будем делать статьи через ChatGPT, т.к. мы занимаемся маркетингом и наша задача быть креативнми, мыслить своей головой, а не выдавать роботизированную информацию. Это может сыграть злую шутку в будущем.
Теперь тексты от сотрудников мы прогоняем через AI detector.


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

ChatGPT - младший аналитик. Используйте его в своей работе, но помните про ошибки. Они есть вплоть до версии 4. И думаю, что не смотря на быстрое развитие и хайп, он еще долго будет обучаться, чтобы давать 100% точные ответы 🤨

❗️Уже через 15 минут❗️

📹Повтор онлайн-практикума Екатерины Ананьевой:
5 главных принципов дизайна REST API

Подключайтесь по ➡️ ссылке