1. Обзор
В Postman переменные позволяют нам сохранять значения и использовать их по мере необходимости в разных API. Мы можем ссылаться на эти значения, передавая их коллекциям, средам или любым запросам. Это в основном упрощает доступ к хранимым значениям, используя эти переменные более эффективно. Мы также можем сотрудничать с несколькими товарищами по команде или настраивать динамические рабочие процессы с помощью Postman, используя эти переменные.
В этой статье мы подробно рассмотрим переменные, их типы и то, как мы можем встроить их в наши API.
2. Что такое переменные?
Переменные символизируют представление данных и позволяют нам получить доступ к значению, не вводя его вручную, где бы оно нам ни понадобилось. Они могут быть полезны, когда нам нужно использовать одно и то же значение в нескольких местах. Некоторые экземпляры включают базовый URL-адрес, токен и переменные пути. Кроме того, их использование также делает запросы более гибкими, поскольку изменение переменных автоматически вносит изменения во все места, где эти переменные используются.
Мы можем определить переменные как пары ключ-значение в Postman. Ключ определяет имя переменной, которое позволяет нам напрямую обращаться к ее значению с помощью этого ключа.
Кроме того, можно также использовать среды для настройки группы переменных. Эти переменные будут иметь разные значения в зависимости от среды.
Давайте углубимся в переменные и разберемся с различными областями действия переменных.
2.1. Области действия переменных
Существует несколько областей, которые позволяют нам обрабатывать разработку и тестирование API в различных средах с разными значениями. Ниже приведены переменные области действия, определяемые от самой широкой до самой узкой охватываемой области:
- Глобальные переменные: они доступны во всем рабочем пространстве и имеют самую широкую область действия в Postman. Их можно использовать где угодно среди нескольких запросов и коллекций в рабочей области.
- Переменные коллекции: эти переменные доступны только внутри определенной коллекции. Они доступны для всех запросов в коллекции. Кроме того, они не меняются в зависимости от выбранной среды.
- Переменные среды: эти переменные позволяют нам масштабировать работу в соответствии с различными средами. Они меняются вместе с изменением среды, над которой мы работаем, такой как локальная среда, промежуточная или производственная среда.
- Переменные данных. Эти типы переменных являются внешними и определяют наборы данных при запуске коллекций с помощью средства запуска коллекций. Мы можем извлечь это из файла CSV или JSON. У них есть текущие значения, которые не сохраняются после выполнения запроса или коллекции.
- Локальные переменные: эти переменные также известны как временные переменные, которые доступны только через сценарий запроса. Они имеют область действия только до текущего запроса или коллекции. После завершения выполнения они больше не доступны.
2.2. Типы переменных
Глобальные переменные и переменные среды можно дополнительно классифицировать на основе их типов. Вот как мы можем их настроить:
- Тип по умолчанию: переменные относятся к этим типам по умолчанию. Они отображаются как обычный текст без дополнительных свойств.
- Тип секрета: эти переменные скрывают начальные и текущие значения для всех рабочих областей, подобно паролю. Они позволяют нам предотвратить любое непреднамеренное раскрытие конфиденциальных данных.
3. Определение переменных с помощью областей видимости
Мы можем определить переменные нескольких типов и с областями действия, как мы обсуждали выше. Переменные могут быть определены в любой области в построителе запросов.
Во-первых, мы выделяем текст и нажимаем «Установить как переменную». После этого мы должны сохранить его как новую переменную. Затем мы вводим ключ для значения и выбираем из различных областей, доступных в Postman:
3.1. Установка тела ответа в качестве переменных
Значения из тела ответа запроса также могут быть установлены в переменные и использоваться в дальнейшем в коллекции. Это помогает выполнять несколько запросов последовательно и создавать определенный поток.
Во-первых, давайте выберем текст, который мы хотим сохранить, и нажмите правую кнопку мыши или кнопку Control-щелчок, чтобы сохранить его как переменную.
После этого мы должны выбрать соответствующую область из возможных вариантов, то есть среду, локальную или глобальную, и назвать переменную, чтобы сохранить ее:
3.2. Определение глобальных переменных
Давайте рассмотрим шаги по настройке глобальных переменных в Postman:
- Начнем с того, что нажмем «Добавить новую переменную» в разделе «Глобальная переменная», а затем введем имя переменной, чтобы сохранить ее как глобальную переменную напрямую.
- Другой вариант — выбрать значение и сохранить переменную, выбрав параметр Global в качестве типа.
- После этого мы не должны забыть отметить значок Сохранить и подтвердить изменения.
Мы также можем загрузить глобальные переменные и поделиться ими с другими, выполнив следующие действия:
- Во-первых, давайте перейдем к Postman и выберем тип среды как Global на боковой панели.
- Затем мы можем нажать кнопку «Экспорт», которая экспортирует переменные в файл.
- Мы можем сохранить файл, как только он будет готов, щелкнув значок «Сохранить» в системе и предоставив доступ к нему по мере необходимости.
3.3. Определение переменных среды
Мы можем выполнить следующие шаги, чтобы сохранить переменные среды в Postman:
- Во-первых, мы нажимаем «Добавить новую переменную» и «Вводим имя переменной».
- Перед сохранением переменной мы можем выбрать тип переменной в качестве среды.
- Для переменной потребуется указать начальное и текущее значения.
- После этого мы должны нажать на значок «Сохранить», чтобы подтвердить изменения.
3.4. Определение переменных коллекции
Postman также предоставляет возможность добавлять переменные коллекции и использовать их по мере необходимости.
Мы должны щелкнуть и выбрать «Коллекции» на боковой панели. После этого давайте выберем вкладку Variables для хранения переменных коллекции:
3.5 Определение переменных в сценариях
Подобно определению переменных в коллекции, среде или глобально, мы также можем программно устанавливать переменные в наших сценариях запросов.
Все эти методы принимают (variable_key, variable_value) в качестве входных данных:
- pm.globals: этот метод используется для определения глобальных переменных в скрипте запроса, например, pm.globals.set("variable_key", "variable_value");
- pm.collectionVariables: мы можем определить переменную с областью действия как «коллекцию» с помощью этого метода, например, pm.collectionVariables.set («variable_key», «variable_value»);
- pm.environment: это можно использовать для определения переменной среды с областью действия как текущая среда, например, pm.environment.set("variable_key", "variable_value");
- pm.variables: определяет локальную переменную с локальной/временной областью действия, например, pm.variables.set("variable_key", "variable_value");
- unset: этот метод можно использовать для удаления установленной переменной. Отмена может быть определена с помощью вышеуказанных экземпляров переменных в соответствии с их областью действия, например, pm.environment.unset("variable_key", "variable_value");
3.6 Использование переменных в сценариях
Мы сохранили переменные в сценариях, используя описанные выше методы. Поэтому мы можем получить их текущее значение, используя эти методы:
- pm.variables.get("variable_key"): это позволит получить доступ к переменной в любой области, включая локальную.
- pm.globals.get("variable_key"): это может получить доступ к глобальной переменной
- pm.collectionVariables.get("variable_key"): это может получить доступ к переменной коллекции.
- pm.environment.get("variable_key"): это может получить доступ к переменной среды.
Здесь мы можем получить значения с помощью variable_key. Объект представляет уровень области видимости, а метод get() извлекает значение.
Метод pm.variables.get() также предоставляет возможность изменять области действия переменных, фактически не влияя на функциональность скрипта. Он возвращает переменную, которая в настоящее время имеет наивысший приоритет.
4. Использование переменных
Теперь мы определили различные области видимости переменных и научились хранить их в Postman. Давайте посмотрим, как использовать эти переменные в наших путях и телах запросов.
Для ссылки на переменную в Postman мы должны использовать двойные фигурные скобки вокруг имени переменной. Он автоматически извлекает значение из разных переменных, как определено. Это стандартно для всего Postman и не зависит от типов и областей действия переменных:
{{studentName}}
Кроме того, запуск CURL или выполнение запроса разрешает переменную и обновляет переменную текущим значением. Приведенный ниже URL-адрес запроса ссылается на переменную:
http://localhost:8080/get?student_name={{studentName}}
Предположим, имя ученика — «Джон». Почтальон извлекает значение из своих переменных и отправляет любое значение, которое в данный момент там хранится. Поэтому при попадании вышеуказанного запроса через Postman он автоматически преобразует его в запрос:
http://localhost:8080/get?student_name=John
5. Вывод
В этом руководстве мы использовали переменные Postman для базовой инициализации в режиме графического интерфейса.
Кроме того, мы узнали об их типах и областях применения. Кроме того, мы рассмотрели различные места, где они могут быть инициализированы, такие как URI, тело запроса и заголовки. Очевидно, это позволяет нам сэкономить время и место, не инициализируя одни и те же значения несколько раз.
Оригинал статьи: https://www.baeldung.com/java-postman-variables
