В этом уроке мы не просто рассмотрим базовый интерфейс Postman, но и узнаем, как этот инструмент поможет нам взаимодействовать с API и изучать полученные ответы. Мы научимся отправлять HTTP-запросы, получать ответы от сервера, а также узнаем, как сохранять свои запросы. Научимся организовывать свою работу с помощью воркспейсов. После этого занятия вы сможете свободно ориентироваться в интерфейсе приложения и выполнять простые запросы
Postman доступен прямо в браузере, так что вам не понадобится ничего устанавливать на свой компьютер. Чтобы открыть веб-версию приложения, перейдите по этой ссылке
При первом запуске вам будет предложено создать учетную запись или войти в уже существующую. Если у вас есть зарегистрированный аккаунт, введите свои учетные данные и нажмите кнопку "Войти". Если учетной записи нет, создайте новую, нажав на соответствующую ссылку и следуйте инструкциям на экране. После завершения регистрации вы сможете получить доступ ко всем возможностям Postman
Обзор интерфейса Postman
После запуска Postman вы увидите достаточно обширный интерфейс, который состоит из нескольких основных элементов
В верхней части экрана находится шапка (Header). Элементы в этой области позволяют вам создавать воркспейсы и переключаться между ними, выполнять поиск в Postman, просматривать уведомления, а также получать доступ к своим настройкам, учетной записи и тарифному плану Postman.
Вся работа в Postman происходит в рамках воркспейса. В левой части окна находится панель вашего воркспейса (Workspaces)
Воркспейс - это специальное рабочее пространство, где вы можете организовывать и управлять всеми инструментами для работы с API. В рамках одного рабочего пространства вы можете создавать коллекции запросов, сохранять переменные, настраивать окружения и использовать тесты. Кроме того, воркспейс поддерживает командное взаимодействие. Вы можете пригласить коллег, делиться коллекциями и документами, а также отслеживать изменения, что делает совместную работу более продуктивной. Можно представить себе воркспейс как виртуальный офис, который вы можете обставить как вам удобно, и работать в нем одному или пригласить коллег для совместной работы.
Как и в случае с офисом, нет жестких правил для организации воркспейса. Одним из удачных подходов является создание воркспейса, посвященного каждому проекту. В нашем курсе мы будем использовать именно этот подход, так как он позволяет эффективно управлять и отделять разные проекты друг от друга.
В правой части экрана находится рабочая область. Рабочая область Postman — это то место, где мы выполняем большую часть своей работы. Здесь мы будем создавать, настраивать и отправлять запросы. Получать и изучать ответы.
Когда вы открываете различные элементы, такие как запросы, коллекции или окружения, в рабочей области Postman они отображаются в виде вкладок в верхней части интерфейса. Это позволяет вам одновременно работать с несколькими элементами, переключаясь между вкладками, не теряя при этом контекст и не открывая новые окна.
В нижней части экрана расположен футер. Он позволяет находить и заменять текст, открывать консоль, работать с файлами cookie, а также получать доступ к ряду других инструментов.
Создание базового запроса
Перейдем от описания к действиям и продолжим изучение интерфейса, выполнив наш первый запрос.
Чтобы создать новый запрос, откройте новую вкладку. Это можно сделать, нажав + в верхней части рабочей области. Рассмотрим подробнее рабочую область:
Рабочая область запроса разделена на две части. В верхней части мы будем настраивать и отправлять запрос, в нижней части окна будут отображаться результаты выполнения запроса.
Чтобы отправить запрос, выполните следующие шаги:
Выберите HTTP метод. Нажмите на выпадающий список, расположенный слева от поля URL, и выберите метод GET. Мы будем использовать метод GET для получения данных.
В поле для ввода URL введите адрес API, с которым хотите работать. Мы будем использовать для примеров URL http://http.hexlet.app/postman/users, сделав GET запрос на который можно получить список всех пользователей
Нажмите на кнопку Send (Отправить). Postman выполнит запрос к указанному URL, и вы сможете увидеть ответ сервера.
Также вы можете посмотреть сформированный сырой HTTP запрос на вкладке Code в правой боковой панели. Для этого нажмите на значок </> на правой боковой панели:
Изучение результатов
После того как вы отправите запрос, внизу экрана появится панель с ответом сервера. Ответ на наш запрос состоит из кода состояния HTTP, тела и заголовков. Посмотрим подробнее, какую информацию об ответе мы можем получить:
Сразу в верхней части вы увидите статус ответа. Статус 200 OK означает, запрос выполнен успешно и данные получены
На вкладке Body вы можете посмотреть тело запроса. Мы получили список пользователей в формате JSON. Вы можете переключаться между различными форматами представления этого тела (например, "Pretty", "Raw", "Visualize"), чтобы лучше видеть данные.
На вкладке Headers отображаются заголовки ответа в виде пар ключ-значение. В этом заголовков вы можете увидеть дополнительную информацию об ответе, необходимую для взаимодействия между клиентом и сервером. Например, о типе контента
Сохранение запроса в папку
Теперь, когда мы создали и протестировали запрос, давайте сохраним его, чтобы в следующий раз не настраивать заново
- Нажмите на кнопку "Save" (Сохранить) в верхней части окна запроса.
- В открывшемся окне выберите или создайте папку, в которую хотите сохранить запрос.
- Дайте вашему запросу информативное имя, чтобы впоследствии было легко его идентифицировать. После этого нажмите "Save" (Сохранить).
В дальнейшем вы сможете без труда найти этот запрос выполнить его повторно. Для этого откройте вкладку Collections на боковой панели и найдите в ней свой сохраненный запрос
Самостоятельная работа
Проделайте все шаги из урока у себя на компьютере. Для тренировки используйте наше приложение http.hexlet.app/postman. Список доступных маршрутов можно посмотреть в браузере по адресу https://http.hexlet.app/postman-openapi
Выполните несколько GET запросов — получите список всех пользователей и данные конкретного пользователя. Изучите полученные ответы — тело и заголовки. Попробуйте различные форматы отображения тела ответа, сравните результаты
Дополнительные материалы
- Официальный сайт приложения Postman
- Веб версия Postman, открывается в браузере
- Десктопная версия Postman для различных операционных систем
- Еще спобобы организации воркспейсов в Postman
Для полного доступа к курсу нужен базовый план
Базовый план откроет полный доступ ко всем курсам, упражнениям и урокам Хекслета, проектам и пожизненный доступ к теории пройденных уроков. Подписку можно отменить в любой момент.
