GetAnalyst - REST API _ Гайд по JSON.pdf
10.2 MB
🔥 Книга по JSON в REST API 🔥 + история про собеседования
Нанимаем системного аналитика на проект, где нужно работать с web-, mobile и backend.
Есть публичная REST API-документация. Опубликована на официальном сайте. Протестировать бесплатно нельзя, почитать бесплатно можно.
Все приложения есть в открытом доступе, можно зарегистрироваться и посмотреть что внутри до собеседования.
Для технической части собеседования не придумываем ничего заумного, а даём реальную задачу из проекта:
👌 Тип метода GET, POST, PUT, PATCH или DELETE выбирают правильно почти всегда.
👌 URL делают, не всегда так, как ожидаем. Но хотя бы понимаем, где придётся доучить.
🥲 А вот когда дело доходит до JSON, то тут мы можем смело принимать решение о продолжении диалога.
🔴 👉 Типичные ошибки и недочеты в JSON:
- Незнание типов данных
- Дата и время - про стандарты ISO не слышали
- Умение самостоятельно описать только "плоские" объекты данных, без вложенных структур
- JSON запроса и ответа одинаковые, либо один из них теряется в случае методов, отличных от GET
- Неумение работать со списками - массивы
- Нейминг (именование полей) порой заставляет и смеяться, и плакать
- Отсутствие знаний базовых структур для методов
+ Незнание инструментов, что сразу показывает отсутствие опыта
Это самое-самое, что бросается в глаза с первых минут.
Давайте не будем допускать эти ошибки? 🙂
Руководство по JSON, прикрепленный к посту - ваш будущий помощник и ориентир в проектировании API 📘
В нем собрала самое ключевое, чтобы не валить ваши собеседования и качественно выполнять свою работу 🙌
-----
P.S.
И большой намек к этому посту:
🚨 REST API-документацию компании можно изучить до собеседования, если она есть в открытом доступе.
Это полезно, чтобы понять, что будут ожидать на практике, и посмотреть на подходы работы в компании.
-----
Запоминаем, сохраняем, пользуемся 🙏
#RestApiGA
Нанимаем системного аналитика на проект, где нужно работать с web-, mobile и backend.
Есть публичная REST API-документация. Опубликована на официальном сайте. Протестировать бесплатно нельзя, почитать бесплатно можно.
Все приложения есть в открытом доступе, можно зарегистрироваться и посмотреть что внутри до собеседования.
Для технической части собеседования не придумываем ничего заумного, а даём реальную задачу из проекта:
Есть экран веб-приложения.
Перед кандидатом скриншот с уже реализованной функциональностью в системе.
Нужно описать REST API метод(-ы) для работы этого экрана.
👌 Тип метода GET, POST, PUT, PATCH или DELETE выбирают правильно почти всегда.
👌 URL делают, не всегда так, как ожидаем. Но хотя бы понимаем, где придётся доучить.
🥲 А вот когда дело доходит до JSON, то тут мы можем смело принимать решение о продолжении диалога.
🔴 👉 Типичные ошибки и недочеты в JSON:
- Незнание типов данных
- Дата и время - про стандарты ISO не слышали
- Умение самостоятельно описать только "плоские" объекты данных, без вложенных структур
- JSON запроса и ответа одинаковые, либо один из них теряется в случае методов, отличных от GET
- Неумение работать со списками - массивы
- Нейминг (именование полей) порой заставляет и смеяться, и плакать
- Отсутствие знаний базовых структур для методов
+ Незнание инструментов, что сразу показывает отсутствие опыта
Это самое-самое, что бросается в глаза с первых минут.
Давайте не будем допускать эти ошибки? 🙂
Руководство по JSON, прикрепленный к посту - ваш будущий помощник и ориентир в проектировании API 📘
В нем собрала самое ключевое, чтобы не валить ваши собеседования и качественно выполнять свою работу 🙌
-----
P.S.
И большой намек к этому посту:
Это полезно, чтобы понять, что будут ожидать на практике, и посмотреть на подходы работы в компании.
-----
Запоминаем, сохраняем, пользуемся 🙏
#RestApiGA
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥58❤🔥11👍6🤩4❤2
🟢🟠 Инструменты системного аналитика для работы с 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