Postman — это сервис для создания, тестирования, документирования, публикации и обслуживания API.
Это бесплатное решение, которое вы можете установить перейдя на официальный сайт.
Postman не требует настройки, поэтому вы можете начать работать сразу после установки.
Для того чтобы сохранять прогресс работы в программе Postman и работать в команде вам необходимо зарегистрировать аккаунт.
Для личного использования вы можете работать абсолютно бесплатно.
Создание рабочего пространства в Postman
Для начала необходимо создать рабочее пространство. Если вы работаете в команду, то вы можете добавить своих коллег в созданное пространство.
Создав рабочее пространство, создаем наш проект, для этого нажимаем на иконку плюс в верхнем левом углу и выбираем пункт Blank collection.
Внутри нового проекта создадим директории в которых будут отдельные части нашего проекта. В этих директориях будут находиться запросы.
Коллекцию можно рассматривать, как файл проекта. Коллекция объединяет в себе все связанные запросы.
Папка — используется для объединения запросов в одну группу внутри коллекции. К примеру, вы можете создать папку для первой версии своего API — "v1", а внутри сгруппировать запросы по смыслу выполняемых действий — "Order & Checkout", "User profile" и т. п.
Запрос — основная составляющая коллекции, то ради чего все и затевалось. Запрос создается в конструкторе. Конструктор запросов это главное пространство, с которым вам придётся работать.
Добавление переменных в Postman
Postman поддерживает создание переменных, в которых можно хранить URL адреса, токены, и прочие строковые параметры. Это можно сделать перейдя во вкладку Variables
Давайте создадим переменную с указанием основного URL адрес.
Переменные также доступны и в скриптах:
// получить глобальную переменную
pm.globals.get("variable_key");
// получить переменную из окружения
pm.environment.get("variable_key");
// получить переменную из любого пространства согласно приоритету
pm.variables.get("variable_key");
Отправка GET запросов в Postman
Следующим этапом добавим запросы. Давайте выберем тип запроса и укажем URL.
Postman поддерживает все популярные типы запросов а именно: GET, POST, PUT, PATCH, DELETE.
Так как мы создали отдельную переменную для нашего базового URL, нам необходимо вызвать эту переменную в поле. Для этого в двойных фигурных скобках указываем название нашей переменной, а затем добавляем относительный путь до нашего обработчика.
Для отправки запроса достаточно нажать на кнопку Send.
Указание GET параметров
Во вкладке params вы можете указать дополнительные параметры для нашего запроса для этого в поле key необходимо указать ключ, а в поле value — значение.
Настройка авторизации
Если для запроса требуется авторизация, то вы можете передать параметры для авторизации во вкладке Authorization.
Настройка заголовков для запросов
Если при создании запроса вам необходимо передать дополнительные заголовки вы можете это сделать во вкладке headers.
По умолчанию сервис Postman генерирует стандартные заголовки для запросов. При необходимости, вы можете их отключить или изменить значение данных заголовка.
Отправка POST запросов в Postman
Давайте представим что нам необходимо протестировать обработчик который принимает POST запрос из формы на сайте.
Выбираем метод POST, а для указания параметров переходим во вкладку Body.
Есть несколько вариантов передачи параметров в теле запроса:
Для передачи данных в формате ключ значение нам необходимо перейти во вкладку form-data.
Если нам необходимо передать данные в формате JSON объекта, то переходим во вкладку raw.
Тестирование в Postman
Главным преимуществом программы Postman является возможность написания тест-кейсов для запросов.
Вы можете писать скрипты для тестирования, как для всего проекта, так и для отдельной директории и конкретного запроса.
Для написания кейсов вам необходимо перейти во вкладку Scripts.
Здесь вы можете воспользоваться готовыми скриптами или же используя синтаксис написать свои скрипты для тестирования.
Генерация кода для запроса
Если вы только учитесь работать с HTTP запросами, то Postman поможет вам в написании скриптов.
После того как вы указали все необходимые параметры вы можете сгенерировать код для запроса, для этого достаточно нажать на пункт «Code» в правом меню и выбрать необходимый язык программирования.
В моем случае я выберу PHP и получу пример Curl запроса со всеми необходимыми параметрами.
Postman + Swagger
Вторым главным преимуществом сервиса Postman является прямая совместимость с архитектурой Swagger. Вы можете загружать в Postman готовые Swagger схемы.
