Окружения — Тестирование API c Postman

• Переменные
  • Создание переменной
  • Использование переменной
• Окружения
  • Создание переменных окружения
  • Переключение между окружениями

Каждый проект функционирует в определенной обстановке, которую называют окружением. Например, во время разработки приложение находится на компьютере у программиста, эту среду называют средой разработки. После завершения разработки и выпуска проект переносится в рабочую среду, где он используется реальными пользователями - это так называемая продакшн среда. Окружений может быть и больше, но как правило эти два есть всегда.

Допустим, что вы работаете над проектом, где необходимо взаимодействовать с API в разных условиях. У вас может быть одна версия API для продакшн-среды, другая для тестирования, и третья — для локальной разработки. Каждое из этих условий требует своих настроек, например могут различаться URL эндпоинтов и токены авторизации. Теперь представьте, что каждый раз, когда вы переключаетесь между окружениями, вам придется вручную ходить и изменять настройки в запросах. Это сильно затрудняет работу, значительно растет вероятность допустить ошибку, забыть что-то поменять

Здесь на помощь приходят окружения в Postman. Окружения представляют собой набор переменных, на которые вы можете ссылаться при отправке запросов. С помощью Postman вы можете создавать различные окружения, такие как "продакшн" и "разработка", что позволяет вам быстро переключаться между ними.

Переменные

Выше мы обсудили, зачем нужны окружения в Postman. Так как окружения представляют собой набор переменных, давайте сначала более подробно рассмотрим, что такое переменные и как работать с ними в Postman.

Переменные представляют собой символическое обозначение данных, которое позволяет легко обращаться к значениям, не вводя их вручную каждый раз. Это особенно полезно, когда одно и то же значение используется в нескольких местах. Переменные помогают хранить и повторно использовать значения в Postman, что значительно упрощает работу с запросами и коллекциями.

Каждая переменная в Postman — это пара "ключ-значение". Имя переменной служит ключом, а доступ к ее значению осуществляется через это имя.

Предположим, у вас есть один и тот же URL-адрес в нескольких запросах и при этом он может измениться позже. Чтобы не писать этот URL-адрес руками в каждом запросе, вы можете сохранить его в переменной base_url, а затем использовать имя этой переменной в запросах вместо фактического адреса

Создание переменной

• Нажмите Environment на боковой панели и выберите Globals

• Чтобы добавить новую переменную, выберите нижнюю строку таблицы и введите имя переменной — base_url

• Выберите тип переменной default. Тип default означает, что значение переменной будет отображаться как есть. Если вы выберете secret, значение переменной будет скрыто. Этот тип переменной подходит для конфиденциальных данных, например токенов аутентификации

• Введите начальное значение и текущее значение для переменной — http://http.hexlet.app/postman

  Начальное значение синхронизируется с вашей учетной записью. Оно доступно всем сотрудникам, имеющим доступ к воркспейсу

  Текущее значение используется при отправке запросов в локальном экземпляре Postman. Он никогда не синхронизируется с вашей учетной записью и не передается вашей команде.

  Если вы оставите текущее значение пустым, оно будет скопировано из начального

• Нажмите Save, чтобы сохранить сделанные изменения

Использование переменной

Для ссылки на переменную в Postman используются двойные фигурные скобки. Чтобы обратиться к переменной с именем base_url, используйте следующий синтаксис:

{{base_url}}

Когда вы отправите запрос, Postman заменит переменную ее текущим значением. Например, у нас есть адрес со ссылкой на переменную, который выглядит так:

{{base_url}}/users

При отправке запроса Posman отправит его на адрес http://http.hexlet.app/postman/users. Убедимся в этом, посмотрев сформированный HTTP запрос:

GET /postman/users HTTP/1.1
Host: http.hexlet.app
Accept: application/json

Если вам понадобится изменить базовый URL, вы можете просто обновить значение переменной base_url в одном месте, и это изменение автоматически отразится во всех запросах, где используется эта переменная. Вы можете использовать переменные не только в URL-адресах запросов, но и в параметрах запроса, в заголовках, в авторизации и в теле.

Окружения

Теперь, когда вы знаете, как хранить данные в переменных и использовать их в запросах в Postman, вы можете перейти к следующему шагу: созданию окружений в Postman.

Окружения в Postman позволяют создавать наборы переменных, которые соответствуют конкретным контекстам, таким как «Разработка», «Тестирование» или «Продакшн». Это означает, что вы можете настроить переменные один раз для каждого окружения и быстро переключаться между ними, не беспокоясь о том, чтобы менять значение каждой отдельной переменной вручную

Создадим наше первое окружение для работы с приложением, развернутом в продакшене

• Выберите Environments на боковой панели и нажмите +.

  

• Введите имя для окружения Production. Вы можете выбрать любое имя, но оно должно отражать суть

Создание переменных окружения

Добавлять переменные можно сразу при создании окружения. Вы также можете добавлять новые переменные окружения в уже существующем окружении

Процесс создания переменных нам уже знаком. Он ничем не отличается от того, что мы рассмотрели выше. Нужно учесть только то, что переменные мы добавляем в созданное нами окружение. Для примера возьмем ту же переменную base_url, так базовый URL будет зависеть от окружения

• Нажмите Environments на боковой панели и выберите наше окружение Production
• В рабочей области добавьте переменную base_url со значением http://http.hexlet.app/postman

Вы можете добавить здесь столько переменных, сколько вам нужно. Не забудьте в конце нажать Save, чтобы сохранить изменения

Переключение между окружениями

Postman отображает активное окружение в правом верхнем углу рабочей зоны. Когда вы отправляете запрос, Postman использует текущие значения переменных в активном окружении. Если вам нужно переключиться в другое окружение, выберите его в селекторе

Чтобы быстро проверить значение переменных в выбранной среде, выберите значок быстрого просмотра рядом со списком окружений. В окне быстрого просмотра среды перечислены текущие значения для всех переменных в активной среде

В этом уроке мы познакомились с окружениями в Postman. Благодаря возможности группировать переменные по разным окружениям, вы можете быстро и легко переключаться между настройками. Окружения — это мощный инструмент, который поможет вам работать более продуктивно, особенно если вы часто переключаетесь между различными средами разработки, тестирования и продакшена.

Самостоятельная работа

1. Выполните все шаги из урока у себя на компьютере
2. Создайте еще одно окружение для локальной разработки. Предположим, вы разрабатываете наше приложение из урока у себя на компьютере. При разработке оно стартует у вас локально на порту 3000, его базовый URL-адрес будет http://localhost:3000.
3. Переключайтесь между окружениями и посмотрите, как меняется значение переменной base_url в зависимости от выбранного окружения

Дополнительные материалы

1. Среды разаработки и какие они бывают
2. Переменные и окружения. Документация Posman