🟢🟠 Инструменты системного аналитика для работы с API 🟡🟣
Работа с API — важный навык для системного аналитика.
👉 Для работы с интеграциями:
Системному аналитику необходимо убедиться, что API внешней системы будет работать именно так, как описано в документации (если она есть, а если нет - то составить), чтобы затем предоставить информацию разработчикам.
Тестирование API внешних систем в специализированных инструментах помогает выявить проблемы в работе внешних систем на ранних стадиях разработки, несоответствия документации реальности, а также проверить полноту данных и доступность сервисов в целом.
👉 Работа с Backend и мобильными командами:
Нужно уметь самому с нуля проектировать и документировать API, желательно с использованием специализированных инструментов как Postman и Swagger, а не только в Confluence-подобных системах.
Список инструментов, которые помогают системным аналитикам в тестировании и документировании API:
🟠 Postman
🟡 SoapUI
🟣 Insomnia
🟢 Swagger
Подробности в картинках к посту ☝️
👉 В конце рекомендую поработать с инструментами
Делюсь своими практическими гайдами, с которыми вы сможете поработать с инструментами сами, с понятными пошаговыми инструкциями:
▫️ Postman: Практическое руководство с примером тестирования открытого API
▫️ GraphQL — знакомство на практике через Postman [пошаговая инструкция]
▫️ Postman: навык тестирования REST API за вечер
+ скоро добавлю для вас Swagger.
#RestApiGA #ИнтеграцииGA
Работа с API — важный навык для системного аналитика.
👉 Для работы с интеграциями:
Системному аналитику необходимо убедиться, что API внешней системы будет работать именно так, как описано в документации (если она есть, а если нет - то составить), чтобы затем предоставить информацию разработчикам.
Тестирование API внешних систем в специализированных инструментах помогает выявить проблемы в работе внешних систем на ранних стадиях разработки, несоответствия документации реальности, а также проверить полноту данных и доступность сервисов в целом.
👉 Работа с Backend и мобильными командами:
Нужно уметь самому с нуля проектировать и документировать API, желательно с использованием специализированных инструментов как Postman и Swagger, а не только в Confluence-подобных системах.
Список инструментов, которые помогают системным аналитикам в тестировании и документировании API:
🟠 Postman
🟡 SoapUI
🟣 Insomnia
🟢 Swagger
Подробности в картинках к посту ☝️
👉 В конце рекомендую поработать с инструментами
Делюсь своими практическими гайдами, с которыми вы сможете поработать с инструментами сами, с понятными пошаговыми инструкциями:
▫️ Postman: Практическое руководство с примером тестирования открытого API
▫️ GraphQL — знакомство на практике через Postman [пошаговая инструкция]
▫️ Postman: навык тестирования REST API за вечер
+ скоро добавлю для вас Swagger.
#RestApiGA #ИнтеграцииGA
🔥34❤10👍6😁2
Прошедшую неделю официально объявляю неделей офферов, а январь - месяцем активного найма 💪
После того, как я несколько раз написала в канале, что для нас действительно важно и приятно знать, что вы растёте в карьере с GetAnalyst, то нам в ЛС стали чаще приходить новости об офферах 🎉
Только за эту неделю 5 радостных сообщений почти по всем программам ⚡️ включая начинающих СА
👉 Так что если кто-то думает, что в январе "мертвый месяц" для найма и все только-только отходят от праздников - это не так.
А еще я вижу, как команда трудится над оформлением историй студентов за конец прошлого года. Их много!
Душа радуется за всех вас!
И появляется еще больше неугасающего желания делиться и создавать лучших специалистов в IT!
а не умельцев проходить собеседования
Одну историю и несколько ярких сообщений публикую в картинках к посту.
Спасибо каждому из вас за время на обратную связь ❤️🔥
Искренне ваши,
Екатерина Ананьева,
и команда GetAnalyst
#студентыGetAnalyst
После того, как я несколько раз написала в канале, что для нас действительно важно и приятно знать, что вы растёте в карьере с GetAnalyst, то нам в ЛС стали чаще приходить новости об офферах 🎉
Только за эту неделю 5 радостных сообщений почти по всем программам ⚡️ включая начинающих СА
👉 Так что если кто-то думает, что в январе "мертвый месяц" для найма и все только-только отходят от праздников - это не так.
А еще я вижу, как команда трудится над оформлением историй студентов за конец прошлого года. Их много!
Душа радуется за всех вас!
И появляется еще больше неугасающего желания делиться и создавать лучших специалистов в IT!
Одну историю и несколько ярких сообщений публикую в картинках к посту.
Спасибо каждому из вас за время на обратную связь ❤️🔥
Искренне ваши,
Екатерина Ананьева,
и команда GetAnalyst
#студентыGetAnalyst
🔥14👍4❤🔥3❤2😁2🥰1👏1
ElibraGA by GetAnalyst - Database.png
230.8 KB
На прошлой неделе поделилась с вами книгой по JSON (в комментарии добавила версию для печати). В ней я показываю все необходимые примеры, но…
Чтобы научить вас делать JSON к реальным проектам, давайте применять эту книгу к одному из них: онлайн-библиотека с покупкой книг по подписке #ElibraGA.
👉 От чего зависит вид JSON-объекта:
+ для какого экрана(-ов) мы его делаем,
+ какая БД в проекте,
+ для какого метода REST API мы его делаем.
👉 Знакомлю вас с #ElibraGA:
✅ Макеты приложения в Figma - основные экраны пользовательского МП (моб. прил.)
Ссылка на Figma
+ авторизация и регистрация
+ книги, поиск и фильтры
+ избранное
- экран оплаты подписки не показан, но он есть 🙂
✅ БД проекта (ER диаграмма в Draw.io)
Ссылка на dbdiagram.io
+ ключевые таблицы: user (пользователь), subscription_tariff (тарифы), user_subscription_tariff (история тарифов пользователя, включая текущий), book (книга), user_book_purchase_history (история покупок книг по подписке)
+ ‼️Обратите внимание, БД не просто в draw.io, а интегративная - сделана через код в dbdiagram.io (иногда нужен VPN): все связи можно проверить, каждое поле прокомментировано
👉 Как мы будем это использовать:
1. Выбираем экран и определяем, какое действие для него требуется — это метод REST API: тип и URL.
2. Анализируем данные, отображаемые на экране, и выделяем ключевую сущность.
3. Продумываем, на каких ещё экранах и в каких приложениях системы будут использоваться данные этой сущности.
4. Смотрим, какие данные есть по ключевой и связанным таблицам в БД, чтобы ничего не упустить.
5. Проектируем полный объект JSON, который будет использоваться для ответа метода GET /object/{objectId} с полной информацией о сущности.
6. На основе полного JSON начинаем формулировать требования к JSON-запросам и ответам для всех методов, связанных с этой сущностью, начиная с метода, выбранного в пункте 1.
👉 Подготовительную часть сделали!
Можем переходить к проектированию JSON-ов!
#RestApiGA
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥15❤5😁2🤩2👍1
Актуально добавить знания и опыт по REST API в резюме и портфолио? Тогда рекомендую посмотреть нашу практическую программу:
💻 Дизайн REST API
Уникальный поток с новым форматом:
Результат - 2 проекта в портфолио:
Запись на самых выгодных условиях с дополнительным обучением по БД в подарок.
Есть вопросы? Пишите @getanalyst или заполняйте анкету предзаписи. Мы свяжемся с вами, поможем оценить текущие навыки и ответим на вопросы! 🤝
Please open Telegram to view this post
VIEW IN TELEGRAM
👍3
GetAnalyst_Как_создать_JSON_для_REST_API_Пошаговый_алгоритм.pdf
2.2 MB
📚 Как создать JSON для REST API метода - пошаговый алгоритм на примере проекта #ElibraGA 📚
Подготовила для вас практическое руководство по созданию полного JSON-объекта с примером из реальной жизни.
Полный дизайн JSON-объекта - это, как правило дизайн ответа для метода получения полной информации об одном объекте GET /object/{objectId} (пример: GET /books/{bookId}).
Создается первым, чтобы переиспользование его далее во всех запросах и ответах методов REST API.
То есть аналитика на самом деле делается не для одного метода REST API, а сразу для всех POST, GET, PATCH и других методов, нужных для управления данными об объекте.
Алгоритм:
➕0. Выделить список всех методов, где будет использован объект.
➕ 1. Составить список входных и выходных параметров для каждого метода.
➕ 2. Проверить по БД, что ничего не потеряли, и все нужные данные использованы.
➕ 3. Собрать JSON
Из сложного на этом этапе только понять, что лучше сделать вложенным объектом, что в массив, а что оставить в “плоском списке”.
➕ 4. Использовать результат для создания JSON запросов и ответов отдельных методов.
Детальный разбор шагов на реальном примере есть в книге к посту ☝️
#RestApiGA
Подготовила для вас практическое руководство по созданию полного JSON-объекта с примером из реальной жизни.
Полный дизайн JSON-объекта - это, как правило дизайн ответа для метода получения полной информации об одном объекте GET /object/{objectId} (пример: GET /books/{bookId}).
Создается первым, чтобы переиспользование его далее во всех запросах и ответах методов REST API.
То есть аналитика на самом деле делается не для одного метода REST API, а сразу для всех POST, GET, PATCH и других методов, нужных для управления данными об объекте.
Алгоритм:
➕0. Выделить список всех методов, где будет использован объект.
Результат: список методов POST, GET, PATCH и других для управления данных об одном объекте, для всех ролей пользователей.
Создается с использованием
CRUD-модели.
➕ 1. Составить список входных и выходных параметров для каждого метода.
Результат: Список параметров на русском или другом языке под каждый метод POST, GET, PATCH и другие.
➕ 2. Проверить по БД, что ничего не потеряли, и все нужные данные использованы.
Результат: Список параметров полного JSON-объекта может быть обновлен и дополнен. Иногда после этого шага дорабатывается БД.
➕ 3. Собрать JSON
Из сложного на этом этапе только понять, что лучше сделать вложенным объектом, что в массив, а что оставить в “плоском списке”.
🔗
Руководствопо JSON
тут
🔗
Как понимание БД помогает при создании JSON
🔗
Онлайн-валидатор JSON
Результат: Полный JSON-объект для дальнейшего использования в методах REST API.
➕ 4. Использовать результат для создания JSON запросов и ответов отдельных методов.
Детальный разбор шагов на реальном примере есть в книге к посту ☝️
#RestApiGA
❤🔥18👍13❤3🔥2
🔥 1-3 февраля | Открытый урок по REST API 🔥
Если бы мне снова пришлось осваивать проектирование REST API самостоятельно и с нуля, мои шаги были бы следующие:
1. Найти 5 публичных REST API-документаций.
2. Зарегистрироваться в Postman.
3. Получить доступ к этим API. Протестировать каждый из них через Postman, глядя одновременно на UI приложений и на структуру API-методов.
4. Найти общее и различия в этих API.
5. Пробовать брать боевые задачи и получать обратную связь от моей опытной команды Backend-разработчиков 💪
👉 Минимум теории, максимум практики.
Но бывает, что самому двигаться в этих вопросах тяжело.
И боевых задач с опытной Backend-командой нет...
Поэтому мы подготовили для вас практическое занятие по REST API, на котором познакомим с самой нужной теорией и всеми необходимыми инструментами для системного аналитика:
📚 Знакомство с REST API через Postman: с нуля до рабочих методов
🗓 Доступ 1-3 февраля
🔗 Узнать подробнее и зарегистрироваться
Занятие будет доступно в записи.
Вы сможете подключиться к нему и посмотреть в удобное время.
Этот урок предоставит вам не только теоретические знания, но и практические инструменты для работы.
Регистрируйтесь, учитесь и получайте новый опыт! 🙌
Если бы мне снова пришлось осваивать проектирование REST API самостоятельно и с нуля, мои шаги были бы следующие:
1. Найти 5 публичных REST API-документаций.
2. Зарегистрироваться в Postman.
3. Получить доступ к этим API. Протестировать каждый из них через Postman, глядя одновременно на UI приложений и на структуру API-методов.
4. Найти общее и различия в этих API.
5. Пробовать брать боевые задачи и получать обратную связь от моей опытной команды Backend-разработчиков 💪
👉 Минимум теории, максимум практики.
Но бывает, что самому двигаться в этих вопросах тяжело.
И боевых задач с опытной Backend-командой нет...
Поэтому мы подготовили для вас практическое занятие по REST API, на котором познакомим с самой нужной теорией и всеми необходимыми инструментами для системного аналитика:
📚 Знакомство с REST API через Postman: с нуля до рабочих методов
Занятие будет доступно в записи.
Вы сможете подключиться к нему и посмотреть в удобное время.
Этот урок предоставит вам не только теоретические знания, но и практические инструменты для работы.
Регистрируйтесь, учитесь и получайте новый опыт! 🙌
Please open Telegram to view this post
VIEW IN TELEGRAM
❤18🎉4
Методы REST API - проект ElibraGA [GetAnalyst].pdf
1.2 MB
Для проекта #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
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥13❤5👍5😁2💯2❤🔥1
💥 REST API: спорные вопросы с проектов и собеседований на Системного Аналитика 💥
1. Можно ли использовать метод POST для получения данных?
2. Можно ли сделать в проекте все методы POST?
3. Можно ли в GET передавать тело запроса?
4. Как правильно именовать эндпоинты - ед. число или мн. число (/user или /users)?
5. Как правильно строить URL - нужно ли писать create/update в названии метода?
6. Какой код ответа на метод POST: 200 или 201?
7. Что вернуть в ответ, если получен пустой результат - пустой массив или 404?
Опасная подборка 😄
Подробный разбор ответов в этой статье🔗
#RestApiGA
1. Можно ли использовать метод POST для получения данных?
2. Можно ли сделать в проекте все методы POST?
3. Можно ли в GET передавать тело запроса?
4. Как правильно именовать эндпоинты - ед. число или мн. число (/user или /users)?
5. Как правильно строить URL - нужно ли писать create/update в названии метода?
6. Какой код ответа на метод POST: 200 или 201?
7. Что вернуть в ответ, если получен пустой результат - пустой массив или 404?
Опасная подборка 😄
Подробный разбор ответов в этой статье
#RestApiGA
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥34👍6😁4🦄4❤🔥3❤2😍1