Как писать скрипты в Postman

Кратко рассмотрим основы написания кода на JavaScript.

1. Переменные

Переменная — это контейнер для хранения информации. Ключевое слово var позволяет объявить переменную.

var name = "Кот-астронавт";

var age = 4;

var isReadyForLaunch = true;

var inventory = ["шлем", "перчатки", "паёк"];

2. Функции

Функции создаются с помощью ключевого слова function.

Пусть у нас есть две функции: одна готовит корабль к старту, другая считает запас топлива.

function prepareShip(name) {
    return "Корабль «" + name + "» готов к запуску!";
}

function calculateFuel(distance) {
    return distance * 42;
}

3. Вызов функций

Функции вызываются по имени и могут принимать аргументы. Посмотрим, как это выглядит в коде.

prepareShip("Восход-3");

var fuel = calculateFuel(800);

console.log("Запуск начался!");

Postman предоставляет исполняемую среду, в которой можно писать скрипты на JavaScript — так называемый «Postman Sandbox». Код можно писать в разделе Scripts.

Вызвать специальные функции Postman можно, обратившись к методам и свойствам объекта с именем pm.

1. pm.environment

Через объект pm можно обратиться к свойству environment и динамически получать и устанавливать значения переменных среды.

pm.environment.get("variableName")

pm.environment.set("variableName", "variableValue")

2. pm.globals

Через объект pm можно обратиться к свойству globals и динамически работать с глобальными переменными (доступными для всех сред).

pm.globals.get("variableName")

pm.globals.set("variableName", "variableValue")

3. pm.test

Через объект pm можно обратиться к методу test, в котором можно написать свой тест.

pm.test("Let's check if code is 200",
    function () {
        pm.response.to.have.status(200);
    }
);

Скрипты, описанные в разделе Scripts —> Pre-request выполняются перед тем, как будет отправлен запрос. Это может быть любой код на JavaScript, но ключевой объект, к свойствам которого мы получаем доступ в разделе Pre-request — это request. Обратиться к нему можно через pm.request. Если нажать точку, то в выпадающем списке отобразится список всех доступных методов.

pm.request.headers.add({
    key: "Authorization",
    value: "Bearer jwt"
});

Скрипты, описанные в разделе Scripts —> Post-response (Tests) выполняются уже после того, как запрос был отправлен и получен ответ от сервера. Помимо возможности обращаться к request, теперь у нас есть доступ к ответу — объекту response. Обратиться к нему можно через pm.response. После ввода точки отобразится список всех доступных методов.

Именно в Post-response чаще всего пишут автоматизированные проверки, чтобы убедиться, что ответ сервера соответствует ожиданиям. Чтобы написать тест вызовите pm.test и передайте туда произвольное название теста и функцию, которая будет выполнена после отправки запроса. Результат выполнения функции изменит статус теста на true = PASSED либо false = FAILED и отобразится в секции Test Results.

pm.response.code

pm.response.json()

Подытожим: с помощью скриптов в Postman можно автоматизировать часть работы — сгенерировать тестовые данные, подготовить запрос и написать автоматические проверки ответов сервера.

Возможности Postman для написания полноценных автотестов ограничены, однако для базового тестирования API этого достаточно. Для всеобъемлющих автоматизированных тестовых сценариев придётся изучить язык программирования, например, Java или Python, и погрузиться в экосистему тестовых фреймворков и инструментов, таких как Selenium, Playwright, Rest Assured.