1.4 Основные элементы интерфейса Postman и 1.5 Ручное тестирование api с Postman. Отправка первого запроса
Нам потребуется создать новое рабочее пространство (Workspace). В верхнем меню выбираем соответствующий пункт и нажимаем кнопку Create Workspace.
В открывшемся окне вводим название нашего рабочего пространства. Пусть это будет Postman for beginners. В поле Summary можем добавить краткое описание. Затем можно указать уровень доступа. Т.к. я не планирую совместное использование своих запросов с кем-то еще, выбираю настройку Personal. Это значит, что созданный workspace будет доступен только мне. В конце нажимаем кнопку Create Workspace.
Теперь рабочее пространство создано и можем двигаться дальше. Перед нами окно приложения. Оно состоит из:
Верхнее меню дает возможность создания рабочего пространства (Workspaces) и доступа к различным api (API Network). Также с его помощью можно делать поиск. Home - содержит вашу домашнюю страницу. На ней можно посмотреть вашу недавнюю активность. С помощью Workspaces - можно создать новое рабочее пространство, выбрать одно из недавно посещенных, либо сделать поиск по существующим.
В боковом меню доступны основные функциональные элементы Postman. В истории (History) вы можете увидеть сделанные ранее запросы. Для более удобного хранения, группировки и поиска таких запросов в Postman есть коллекции (Collections). К остальным элементам бокового меню мы вернемся позже. Если у вас небольшой экран, для удобной работы можно свернуть боковое меню с помощью кнопки в нижнем левом углу.
Большая часть вашей работы в Postman будет проходить в основной рабочей зоне. Основные её части - вкладки, выпадающий список для выбора окружения и правое боковое меню. К двум последним мы вернемся позже. Вкладки нам нужны, для лучшей организации работы с запросами. Здесь Postman сделан по тому же принципу, что и браузеры, где новую страницу удобнее открывать в новой вкладке.
Основная функциональность Postman - возможность создания и отправки запросов к API для проверки его функциональности и получения данных. Для этого не потребуется писать код или команды в терминале. В интерфейсе Postman вы создаете запрос, нажимаете кнопку отправить и получаете ответ от API. API расшифровывается как Application Programming Interface или программный интерфейс приложения. С его помощью мы можем получить доступ к возможностям другого приложения и обмениваться с ним данными. Такое приложение называется API сервером. Отправка запросов и получение ответов происходит через интернет с помощью протокола HTTP. Приложение, которое отправляет запрос, называется клиентом. Это может быть мобильное приложение, web сайт или другой сервис.
Запрос всегда содержит URL вызываемого эндпоинта API и HTTP метод запроса.
Эндпоинт - это URL, который предоставляет доступ к определенной функциональности сервиса. Он позволяет клиентским приложениям отправлять запросы на сервер и получить доступ к данным или выполнить определенные операции. Каждый эндпоинт обычно связан с определенным HTTP-методом, таким как например GET или POST, который определяет тип операции, которую можно выполнить с помощью этого эндпоинта. Наиболее часто используются следующие методы:
- POST - для добавления новых данных
- GET - для чтения данных
- PUT - для обновления данных
- PATCH - для частичного обновления данных
- DELETE - для удаления данных
Давайте попробуем отправить первый запрос. Это будет GET запрос из демонстрационного API Swagger Petstore. Подробнее с ним вы сможете познакомиться по ссылке. Выглядит запрос следующим образом:
https://petstore.swagger.io/v2/store/inventory
Для отправки в Postman выбираем метод GET. Копируем адрес нашего эндпоинта и нажимаем кнопку Send. В результате получаем ответ содержащий данные в виде json объекта.
Здесь мы можем увидеть тело ответа (Body), который мы получили от сервера. Postman автоматически распознает формат JSON и форматирует его, для лучшего восприятия. Помимо Body, мы можем посмотреть куки (Cookies) и заголовки (Headers) ответа, нажав на соответствующие ссылки. Также мы видим, что наш запрос выполнился успешно и в ответе мы получили код ответа 200 OK. На выполнение запроса ушло 700мс. Содержимое в теле ответа, время обработки и размер могут отличаться от примера выше, т.к. на сервисе добавляются новые записи и удаляются старые.
Частые ошибки.
Многие учащиеся копируют адрес запроса из описания курса и вставляют в Postman. Если вы делаете так же, обратите внимание, чтобы адрес скопировался без посторонних символов. Часто вместе с адресом копируются пробелы или переносы строк. В этом случае в результате выполнения запроса, вы получите ответ 404 Not Found.