📌 JSON — пример запроса для шаблона документации 📌

PATCH /products/{productId} - изменение продукта для приложения подсчета калорий G-Food.

К изменению доступны параметры:
- название - "name" - строка,
- описание - "description" - строка,
- штрихкод - "barcode" - строка,
- размер одной порции (грамм) - "portionSizes” (допустимо несколько вариантов) - список с перечислением - название порции ("name") и кол-во грамм ("size"),
- количество ккал на 100 грамм - "kcal",
- белки (г) на 100 грамм - "proteins",
- жиры (г) на 100 грамм - "fats",
- углеводы (г) на 100 грамм - "carbs".

Далее мы дополнительно укажем типы данных для каждого параметра. На этапе описания маппинга.

JSON объекта будет выглядеть как:
{
"name": "Овсяные хлопья",
"description": "Хлопья из цельного овса, богаты клетчаткой и микроэлементами. \nОчень вкусные",
"barcode": "1234567890123",
"portionSizes": [
{
"name": "Маленькая порция",
"size": 30
},
{
"name": "Стандартная порция",
"size": 50
}
],
"kcal": 389,
"proteins": 13,
"fats": 6.9,
"carbs": 66.3
}


Разбирая строку "name": "Овсяные хлопья", уточняю:
🔸 "name" - ключ, название параметра в JSON. Может не совпадать с названием в БД и у тем более на UI.
🔸"Овсяные хлопья" - значение параметра. Берётся из БД, из таблицы с продуктами.



В качестве дополнительных примеров можно взять:
{
"name": "Овсяные хлопья",
"description": "Хлопья из цельного овса, богаты клетчаткой и микроэлементами. \nОчень вкусные",
}

или массив (список):

{
"portionSizes": [
{
"name": "Маленькая порция",
"size": 30
},
{
"name": "Стандартная порция",
"size": 50
}
]
}


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

Вставьте код в JSON Editor Online, чтобы проверить, что получилось 👍

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

Согласитесь, нетворкинг играет огромную роль в нашем успехе и самочувствии. Это как иметь в своем телефоне приложение "поддержка 24/7", только оно написано кодом дружбы и взаимопомощи. 😊

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

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

Иногда, чтобы продолжить движение вперед, нам просто нужно увидеть кого-то, кто уже там, на вершине своего горного пика, машущего нам и кричащего: "Давай, ты тоже можешь!”

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

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

И помни, если когда-нибудь почувствуешь, что тебе нужен тот самый "ластик" или просто доброе слово - пиши нам! В чат, в личные сообщения. Если только зарядку от телефона не забыл дома 😄

Помни, мы твоя поддержка — это твоя суперсила! ❤️

С добром и теплом,
GetAnalyst.

Разработка требований к обработке ошибок в REST API - одна из самых важных и нужных тем к освоению.

Аналитики должны предусмотреть возможные сценарии работы системы: как успешные, так и возможные ошибки. Эти требования к поведению системы затем используются тестировщиками для проверки корректности работы Backend.

Если обработку ошибок не заложить в требования, то сама она автоматически не появится. Увы 😄

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

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

При работе с ответами на запросы REST API проектируют две связанных между собой части:
1. Код HTTP-ответа: есть всегда и зависит от типа запроса или вида ошибки.
2. Тело ответа (⚡️response body): необязательное, может отсутствовать.

‼️HTTP-коды ответов в REST API и их назначение ‼️

Коды, которые должен знать наизусть каждый системный аналитик и разработчик.


🧑‍💻 HTTP-200: "ОК".
Успешное выполнение запроса. Используется преимущественно для GET, PUT, PATCH.

🧑‍💻 HTTP-201: "Создано".
Обычно возвращается для POST и PUT после успешного создания нового ресурса - записи данных в таблицу БД.

🧑‍💻 HTTP-400: "Плохой запрос".
Запрос не может быть обработан из-за неверного синтаксиса - формата запроса. Ошибка на стороне клиента. Например, в номере счета содержится буква или длина фамилии в запросе больше 128 символов, а ожидалось до 128.
Может сопровождаться красивым текстом сообщением, которое можно показать пользователю.

🧑‍💻 HTTP-401: "Неавторизован".
Запрос требует аутентификации пользователя, то есть выполняется приложением или пользователем без авторизации (логина+пароля или ключа доступа в виде токена).

🧑‍💻 HTTP-403: "Запрещено".
Сервер понял запрос, но он отказывается его выполнять. Как правило это связано с тем, что пользователь авторизован, но доступ запрещен - настройка прав доступа к API.

🧑‍💻 HTTP-404: "Не найдено".
Сервер не может найти запрашиваемый ресурс - данные в БД не найдены.

🧑‍💻 HTTP-500: "Внутренняя ошибка сервера".
Возникает, когда сервер столкнулся с ситуацией, которую он не знает как обработать. Ошибка в работе алгоритма.
Может сопровождаться красивым текстом сообщением, которое можно показать пользователю.

🧑‍💻 HTTP-503: "Сервис недоступен".
Сервер временно не может обрабатывать запросы по техническим причинам.


⚠️ Помните, что для каждого из этих кодов можно предусмотреть несколько вариантов сообщений в зависимости от конкретных условий или ошибок. Это важно учитывать при проектировании REST API и анализе поведения системы.

Напоминаю:
если обработку ошибок не заложить в требования, то сама она автоматически не появится. Увы 😄


Сохраняйте важный пост, чтобы не потерять!

Проблемы у системных аналитиков при работе с REST API часто возникают из-за поверхностных знаний и отсутствия глубокого понимания его принципов.

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

😥 Основные трудности в работе с API:
- Необходимость вносить совместимые изменения.
- Отсутствие понимания структуры документации.
- Упущенные детали в требованиях, требующие постоянного уточнения.
- Непонимание как связан API с БД.
- Трудности в создании структуры JSON, удовлетворяющей будущим пользователям готового API.

💪 Для эффективной работы и уверенности на интервью требуется:
+ Глубокое понимание REST, его принципов и стандартов.
+ Наличие демонстрирующих навыки проектов - демо-портфолио API-документации.
+ Готовность к сложным вопросам по проектированию и оптимизации.
+ Понимание потенциальных проблем и способов их решения.
+ Умение обсуждать архитектуру систем.

Готовы начать глубокое погружение в тему REST API?

Подключайтесь сегодня онлайн в 19:00 МСК!

❗️Уже через 3 часа❗️

Практический вебинар с Екатериной Ананьевой!

📹 Про REST API за 2 часа: с нуля до Swagger-документации
⏰ 19:00 - 21:00 Мск

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

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

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

Разобрали:
👉 Что из себя представляет REST API и структуру метода.
👉 По каждому пункту из сруктуры метода разрабатывали и проходили квизы!
👉 Разбирались когда POST, когда PUT, и в чем разница.
👉 SOAP vs REST.
👉 Связь БД, UI и API.
👉 Посмотрели как делать JSON-ы в http://jsoneditoronline.com.
👉 Работали со Swagger-документацией и наблюдали с какими первичными проблемами можно встретиться.
👉 И много других деталей!

Дополнительные инструменты для работы с JSON:
👉 notepad++
👉 https://www.jetbrains.com/idea/

На выходе с практикума у ребят остались:
🔑 Инструкция по наполнению корпоративного гайда по дизайну REST API.
🔑 В течение этой недели пришлю вам исходники Swagger-документации, над которой работали!
🔑 Знания по REST API: как создавать методы с нуля.
🔑 Опыт!

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

Вау? Вау! Вы лучшие! Спасибо за активность и вопросы! 🔥❤️


P.S. Регистрация на повтор будет открыта завтра, т.к. 3.5 часа практики опять. Если я разбираю тему, то копаю и делюсь с вами всеми важными деталями. Это важно 🙌

P.S.S. Мы побили рекорд по количеству участников. Спасибо за такой старт 2024! ❤️

Часовые пояса - это челлендж. Для вас, и для меня. Почти с каждым у нас разница минимум 10 часов, а то и больше. Поэтому эфиры начинаются в 19 Мск (8 утра по моему времени), чтобы я была с вами с зарядом энегнии, а не угасающим огоньком.

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

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



Во время нашего последнего вебинара я обещала вам специальное предложение по программе Дизайн REST API. И вот оно:

🎁 Промокод: REST240124
⏲ Активен только 27 января с 0:00 до 23:59 Мск

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



Спасибо, что вы часть GetAnalyst! 🙌

P.S. Регистрация на повтор вебинара про REST API и Swagger☝️

Уровни искренности в переписке с проектной командой 😀

#GAhahaha

🤖 ChatGPT для проектирования REST API 🤖

Год назад появился искусственный интеллект — ChatGPT. Созданный на основе знаний всего интернета, он становится помощником и для системных аналитиков, в том числе в проектировании REST API.

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


Пример команды:

Работай как системный аналитик.
Проект - [Название проекта].
[Описание ключевых данных о проекте, важных для решения задачи].
Спроектируй метод REST API: [Название метода].
1. Сделай описание метода - что это и для чего.
2. Опиши логику его работы - алгоритм.
3. Покажи пример запроса и ответа. Ответы нужны как успешный, так и обработка ошибок.

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

Кроме того, ChatGPT не знает уникальной информации о вашей компании или конкретных проектах. Так что, пока он помогает с общими задачами, все тонкости проектирования API вам придется учитывать самостоятельно, основываясь на вашем опыте и знаниях. Иначе есть риск получить «кривые» решения.

В ходе работы я собираю и сохраняю различные команды для работы с ChatGPT. Это позволяет мне максимально эффективно использовать его возможности.

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

🛡️ Безопасность в REST API: 3 способа авторизации 🛡️

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

Есть три основных способа авторизации:

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

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

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


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


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

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

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

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

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

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

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

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

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

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

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

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

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



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

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

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

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



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

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

Разбор ответов и опыт по этим вопросам есть в практической программе - Дизайн REST API. Старт уже 31 января!


Делитесь в комментариях своим опытом собеседований и интересными вопросами по API 👍

🟢 Swagger-коллекция с практического вебинара 🟢

В конце практического вебинара ловили ошибки в Swagger и не удалось до конца показать вам как создать полную коллекцию в Swagger и поделиться ей 🥲


Продолжила проект. Делюсь результататами и исходниками:

1. Мы описали JSON объекта "продукт" и посмотрели крутой инструмент для дизайна объектов JSON - JSON Editor Online. Файл JSON, который я экспортировала из своего редактора и который вы можете загрузить в свой редактор в следующем сообщении 👇

2. Мы создали Swagger-проект и получилось показать вам основные сложности работы с его кодом - спецификация OpenAPI. (Отступы! ☝️) Чтобы вы посмотрели исходный код, который должен получиться, я выгрузила для вас исходник YAML, и показала на видео как загрузить его в ваш Swagger.
Исходник в следующем сообщении 👇

3. По этой ссылке доступна APi-документация в Swagger, полученная для нашего примера JSON-объекта "продукт". Созданы два метода POST и GET.


На видео еще раз показала соответствие OpenAPI и соответствующих фрагметов документации. Это основы работы со Swagger.

Что еще важно попробовать для освоения Swagger:
+ Вложенные объеты JSON.
+ Массивы.
+ Указатели на объекты в URL-запросов ( {productId} и подобные).
+ Разные методы.


Самостоятельная работа:
В качестве закрепления практики с практического вебинара опишите в документации пример метода PATCH для нашего проекта G-Food, который обсуждали в чате! 😉 Дополните мой код и посмотрите что у вас получится!

Исходник для Json Editor Online 🔗

Исходник для Swagger по проекту G-Food 🔗