💎 Методы REST API: 9 примеров для понимания принципов дизайна REST API 💎

Для проекта #ElibraGA спроектировала методы, которые надо реализовать для обеспечения работы приложения.


На что обращать внимание при знакомстве с документом:


Методы REST API - для приложения читателя

✔️ Получить список книг
Показаны:
+ Работа с Query-параметрами для пагинации и фильтрации.
+ Показан массив - список книг.
+ Структура списка - его всегда лучше держать внутри {}, даже если не будет элементов пагинации limit, offset, count.

✔️ Получить информацию о выбранной книге
Пример URL получения информации о конкретном объекте из списка по его id.

✔️ Получить список избранных книг пользователя
Обратите внимание на структуру URL и уточнение про авторизацию пользователя.

✔️ Получить информацию о пользователе и его текущей подписке
+ Проанализируйте JSON с информацией о пользователе и его связь с БД.
аналогично проанализируйте JSON метода получения информации о книге по id и его связь с БД.
Какие особенности заметили?
+ Также для пользователя и книги проверьте, что есть в JSON, и чего нет на UI.


Методы REST API - для приложения админа

✔️ Загрузить обложку книги + Загрузить файл книги
Помогут понять, как работать с загрузкой файлов при работе с REST API.
Важно:
1. Сначала грузим файлы в хранилище.
2. Потом создаём книги с использованием готовых ссылок.

✔️ Создать книгу
Обратите внимание, что JSON-запроса по структуре отличается от JSON-ответа.
Например, при создании книги не надо передавать всю информацию об авторе, т.к. подразумеваем, что его уже создали в системе до этого запроса. Нужен только id.

✔️ Редактировать книгу
Вариантов JSON-запроса может быть много.
В ответ рекомендуется всегда возвращать полный JSON-объекта при редактировании. Допустимы другие варианты.

✔️ Удалить (архивировать) книгу
Нет JSON-ов.


Документ разработана в Confluence.


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

Сохраняем в личные архивы 🤝

#RestApiGA

💥 REST API: спорные вопросы с проектов и собеседований на Системного Аналитика 💥

1. Можно ли использовать метод POST для получения данных?
2. Можно ли сделать в проекте все методы POST?
3. Можно ли в GET передавать тело запроса?
4. Как правильно именовать эндпоинты - ед. число или мн. число (/user или /users)?
5. Как правильно строить URL - нужно ли писать create/update в названии метода?
6. Какой код ответа на метод POST: 200 или 201?
7. Что вернуть в ответ, если получен пустой результат - пустой массив или 404?

Опасная подборка 😄

Подробный разбор ответов в этой статье 🔗

#RestApiGA

🔔 Открытый урок по REST API [доступ к записи | 1-3 февраля] 🔔

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

По итогам работы у вас будет собственная коллекция запросов в Postman для портфолио, которой вы сможете поделиться с коллегами и потенциальным работодателем!

Пример такой коллекции можно посмотреть здесь.


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

⭐️ Знакомство с REST API через Postman:
⭐️ с нуля до рабочих методов
🗓 1-3 Февраля
🔗 Подробности и регистрация


Пусть эти выходные пройдут с пользой для вашей карьеры! ⚡️

Друзья, как говорится, «новый год – новая жизнь!»😁
 
Поэтому хотим вам порекомендовать книгу Евы Кац «Жизненный баланс. 82 идеи для управления работой и жизнью, 7 способов мечтать и 6 шагов, чтобы всё реализовать».
 
Это полезное руководство для всех, кто стремится наладить гармонию между работой и личной жизнью.
Автор предлагает практические инструменты и вдохновение для достижения целей.
 
Книга написана в разговорном стиле, с чувством юмора и борьбой со стереотипами✔️
 
#hwGetAnalyst

Сегодня последний день доступа к занятию "Знакомство с REST API через Postman: с нуля до рабочих методов":
🔗 Подробности и регистрация


Это занятие сделано в поддержку практической программы Дизайн REST API.

🎁 В этот раз она запускается в новом уникальном формате, где вы дополнительно получаете:
+ 3 онлайн-занятия
+ 1 проект в портфолио
+ 3 месяца доступа к обучению

Вы получите:
• 25+ часов практических занятий (11 встреч)
• Встреча по разбору индивидуальных проектов
• Теоретические модули в платформе
• Домашние задания для создания индивидуального проекта в портфолио
• Доступ к закрытому Telegram-чату, где мы публикуем уведомления о проходящих вебинарах, полезные ресурсы, ссылки на книги и разбираем ваши вопросы
• Сертификат о повышении квалификации



На занятии "Знакомство с REST API через Postman: с нуля до рабочих методов" мы затронули множество аспектов, необходимых для успешного освоения REST API.


Программа «Дизайн REST API» поможет вам закрепить эти знания, погрузиться в тему глубже, получить больше практики и открыть новые карьерные возможности в системном анализе!

🔗 Узнать подробнее о программе Дизайн REST API


Есть вопросы? Пишите нам на почту [email protected], в Telegram или на сайте. Мы свяжемся с вами, поможем оценить текущие навыки и ответим на вопросы 🙂

💻 Публичная документация API через Postman - пример реализации 💻

Вчера я показала вам заполненный шаблон постановки задачи на REST API и на его основе создала образец документации в 🟠Postman.


Такой формат документации может быть использован в двух случаях:

1. Для внутренней Backend-команды
При описании задач вы можете сразу сохранять всю информацию в Postman, без Confluence.
Ограничения на коллекцию:
+ Доступна только для команды.
+ Не является публичной, так как может содержать приватные данные (например, маппинг с БД и алгоритмы работы).

2. Публичная API-документация для интеграции с вашим сервисом
Если сторонние системы должны интегрироваться с вашей, то необходимо разместить документацию в удобном и доступном формате.
Пример подобной документации можно посмотреть тут.
В ней рекомендуется скрывать технические детали реализации метода, такие как маппинг с БД и алгоритмы работы.


--------------
👉 Пример публичной документации в Postman для проекта #ElibraGA,
где скрыты детали реализации методов:
🔗 ссылка
--------------

На что обратить внимание:
1. Вы можете открыть мою Postman-коллекцию с методами на основе которой сделана эта API-документация.
2. Посмотрите, что я показываю несколько вариантов ответа. Т.е. не только успех, но и ошибки. Это важно для удобства работы с вашим API.


Как сделать аналогичную документацию в Swagger (OpenApi) покажу на этой неделе 🤝

#RestApiGA

💚 Swagger - Open API - Практическое руководство. Часть 1 💚

Меня часто просят показать как работает Swagger.
Поэтому одной из целей последнего проекта по REST API было демо работы с этим инструментом и спецификацией OpenAPI, с использованием которой ведется разработка кода в нём.


Это первая часть практического руководства, по которой вы шаг за шагом научитесь:
✅ Регистрироваться и настраивать аккаунт в Swagger
✅ Ориентироваться в интерфейсе и возможностях инструмента
✅ Создавать демо-проекты в спецификации OpenAPI

🔗 Ваш первый результат будет выглядеть так


Swagger и OpenAPI — это не просто инструменты, а стандарты в REST API.
Их используют разработчики и аналитики для описания, проектирования и тестирования методов API.

Разбираясь в спецификации кода OpenAPI, вы будете лучше понимать, как API устроено изнутри 🙌

Скачиваем руководство и уделяем 15 минут, чтобы освоить новый инструмент!

#RestApiGA

----
P.S. Может потребоваться VPN

🔐 Авторизация в API: что важно для работы с требованиями и собеседований 🔐

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

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


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


Делитесь с коллегами и подписывайтесь на канал подкаста, чтобы следить за релизами новых эпизодов ⚡

✨📚 7 шаблонов архитектуры, которые важно понимать СА 📚✨

Системные аналитики описывают внутреннюю логику работы приложений:
+ связи между данными на UI (экраны), в БД и API,
+ интеграции с внешними системами,
+ алгоритмы обработки данных,
+ и другие технические детали.

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

А вот в сложных продуктовых компаниях, таких как банки, маркетплейсы и страховые компании, базовых знаний недостаточно. Здесь чаще встречается сложная сервисная (SOA) или микросервисная (MSA) архитектура.

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

👉 Собрала для вас 7 основных шаблонов проектирования архитектуры, которые важно понимать СА.

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

1. Монолит
2. Слоистая архитектура
3. Модульная архитектура
4. Клиент-Серверная архитектура
5. Сервис-ориентированная Архитектура (SOA)
6. Микросервисная архитектура (MSA)
7. Событийно-ориентированная архитектура (EDA)

Всю информацию собрала в мини-книгу прикрепленную к посту 📚

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