Коллекции Postman. Часть 1

Содержание:

Организация и автоматизация API-запросов в коллекциях Postman
Создание и управление коллекциями запросов в Postman
Добавление API-запросов в коллекции Postman
Управление и организация коллекций Postman
Совместная работа и обмен коллекциями Postman

Организация и автоматизация API-запросов в коллекциях Postman

Коллекции Postman — это переносимые наборы API-запросов, которые можно повторно использовать, автоматизировать и делиться ими с другими. С помощью коллекции вы можете сохранять важные детали для каждого API-запроса, такие как тип авторизации, параметры и заголовки, тела запросов, скрипты и переменные, а также документацию.

Начните с коллекций

Впервые пользуетесь Postman и коллекциями? Узнайте, как создать свою первую коллекцию в Postman.

Создайте коллекцию, чтобы сохранять API-запросы и организовывать их в папки. Вы можете создать коллекцию с нуля или использовать один из предустановленных шаблонов Postman. Коллекции могут содержать HTTP-запросы, а также запросы, использующие другие протоколы, такие как GraphQL или gRPC.

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

Задачи с собеседования и вакансии для автоматизаторов у нас в телеграм канале "Автоматизация Тестирования".

Запуск и автоматизация коллекций

Используйте Collection Runner, чтобы отправлять некоторые или все API-запросы в коллекции в заданной вами последовательности. Запуск коллекции позволяет протестировать функциональность API или воспроизвести пользовательские сценарии. Вы можете запускать коллекции вручную, по расписанию или с помощью вебхука. Чтобы узнать больше, перейдите на страницу «Тестирование функциональности API»

Вы также можете запускать коллекции из командной строки или в рамках вашего CI/CD-пайплайна, используя Postman CLI или Newman .

Читайте также: Скрипты для тестирования API в Postman

Тестирование производительности API

Вы можете использовать Collection Runner для тестирования производительности API с теми же коллекциями и запросами, которые применяются для функционального тестирования. Симулируйте реальный пользовательский трафик с помощью виртуальных пользователей, чтобы наблюдать, как ваш API ведет себя под нагрузкой. Чтобы узнать больше, перейдите в раздел «Моделирование пользовательского трафика для тестирования производительности API».

Использование коллекций в рабочих процессах разработки API

Коллекции Postman можно применять на всех этапах разработки, тестирования и публикации API:

Просматривайте и создавайте документацию API из коллекций, а также публикуйте её в Интернете.
Создавайте Postman Monitor на основе коллекции, чтобы постоянно отслеживать работоспособность API и получать уведомления при сбоях.
Настраивайте mock-сервер с коллекцией, чтобы имитировать поведение реального сервера для разработки и тестирования API.
Создавайте коллекции из спецификаций API с помощью Postman API Builder.

О формате коллекции

Коллекции Postman основаны на формате коллекции с открытым исходным кодом. Этот формат является переносимым и задает структуру для организации API-запросов и моделирования рабочих процессов API. Формат коллекции удобен как для машинного, так и для человеческого чтения. Его можно использовать для генерации клиентских и серверных SDK, создания документации и настройки mock-серверов.

Чтобы узнать больше, перейдите в документацию по схеме коллекций Postman.

Создание и управление коллекциями запросов в Postman

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

Создание новых коллекций

Создайте новую коллекцию в Postman, чтобы сохранять часто используемые запросы или группировать их для определенных задач, например, тестирования API или моделирования рабочих процессов. Вы можете создать коллекцию с нуля или использовать один из предустановленных шаблонов Postman. Чтобы узнать больше, перейдите в раздел «Создание коллекций API-запросов в Postman».

Добавление API-запросов

Вы можете сохранять новые API-запросы в коллекцию или перемещать существующие запросы в нее. Коллекция может содержать HTTP-запросы, а также запросы других протоколов, таких как GraphQL или gRPC, создавая многопротокольную коллекцию. Чтобы узнать больше, перейдите в раздел «Добавление API-запросов в коллекции Postman».

Поддержание порядка в коллекциях

Вы можете организовать API-запросы в коллекции в любом порядке, который вам удобен, или добавить папки для группировки запросов. Если вы внесли изменения, которые вам не нравятся, или случайно удалили коллекцию, вы можете восстановить ее предыдущее состояние. Чтобы узнать больше, перейдите в раздел «Управление и организация коллекций Postman».

Сотрудничество с другими пользователями

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

Создание коллекций API-запросов в Postman

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

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

Создание новой коллекции

Чтобы создать коллекцию, вам необходимо войти в свою учетную запись Postman .

Создать новую коллекцию можно следующими способами:

Выберите Collections в боковой панели, затем нажмите + > Blank collection.
Выберите New в боковой панели, затем выберите Collection.
В пустом рабочем пространстве выберите Create Collection.
Вы также можете создать коллекцию на основе шаблона .

После создания новой коллекции вы можете добавить API-запросы в коллекцию, а также назвать и настроить её.

Создание коллекции из шаблона

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

Чтобы создать коллекцию из шаблона, выполните следующие шаги:

Выберите Collections в боковой панели, затем нажмите + > Collection template.
Выберите рекомендованный шаблон. Вы также можете поискать шаблон или просмотреть шаблоны по роли или назначению.
Ознакомьтесь с информацией о шаблоне и, когда будете готовы, выберите Use template.

Также можно применить шаблон к уже существующей пустой коллекции. В обзоре коллекции выберите шаблон или нажмите More templates. Невозможно применить шаблон к коллекции, которая уже содержит элементы.

Настройка коллекции

Чтобы настроить и кастомизировать вашу новую коллекцию, выполните следующие действия:

Чтобы переименовать коллекцию, выберите ее название в рабочей области.
Вкладка Overview позволяет добавить описание коллекции, которое также будет отображаться в документации коллекции.
Выберите Authorization, чтобы настроить данные авторизации для всех запросов в коллекции.
Выберите Scripts > Pre-request, чтобы добавить скрипт перед запросом для вашей коллекции. Этот скрипт будет выполняться перед отправкой каждого запроса в коллекции.
Выберите Scripts > Post-response, чтобы добавить скрипт после ответа для вашей коллекции. Этот скрипт будет выполняться после отправки каждого запроса в коллекции.
Выберите Variables, чтобы определить переменные коллекции . Переменные коллекции — это повторно используемые значения, которые можно использовать во всех запросах и документации в коллекции.

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

Добавление API-запросов в коллекции Postman

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

Узнайте больше о создании и отправке запросов .

Добавление запроса в пустую коллекцию

Выберите коллекцию на боковой панели.
Нажмите Add a request.

Сохранение нового запроса в коллекцию

Откройте новый запрос и выберите Save.
Введите название запроса.
Выберите коллекцию, в которую вы хотите сохранить запрос.

Чтобы создать новую коллекцию, выберите New Collection.

Нажмите Save.

Создание нового запроса внутри коллекции

На боковой панели выберите иконку дополнительных действий рядом с коллекцией.
Выберите Add request.

Сохранение запроса из истории в коллекцию

Выберите History на боковой панели.
Нажмите + рядом с запросом и выберите Save Request.

Выберите коллекцию, в которую вы хотите сохранить запрос.

Чтобы создать новую коллекцию для сохранения запроса, выберите New Collection.

Нажмите Save.

Перемещение существующего запроса в другую коллекцию

В боковой панели выберите запрос, который вы хотите переместить. Для выбора нескольких запросов удерживайте ⌘ (Mac) или Ctrl (Windows).
Перетащите запрос в другую коллекцию.

Вы также можете открыть запрос и выбрать Save > Save as, а затем выбрать коллекцию, в которую вы хотите его переместить.

О многопротокольных коллекциях

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

Многопротокольные коллекции не могут содержать HTTP-запросы. Они могут содержать только запросы с такими протоколами:

Многопротокольные коллекции не поддерживают некоторые функции коллекций HTTP, такие как создание mock-серверов и генерация тестов.

Управление и организация коллекций Postman

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

Основы коллекций

Чтобы просмотреть все коллекции в текущем рабочем пространстве, выберите Collections в боковой панели. Здесь вы можете выполнить следующие действия:

Выберите коллекцию, чтобы открыть ее обзор в рабочей области.
Нажмите на стрелку рядом с коллекцией, чтобы развернуть ее содержимое.
Наведите курсор на коллекцию и нажмите на иконку звезды (★), чтобы переместить эту коллекцию в верхнюю часть списка.
Используйте поле поиска на боковой панели для фильтрации коллекций и их содержимого.
Измените порядок запросов, папок и примеров внутри коллекции, перетаскивая их.

Добавление папок в коллекцию

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

Выберите иконку дополнительных действий рядом с коллекцией, затем выберите Add folder. Чтобы добавить подпапку, нажмите на иконку дополнительных действий рядом с папкой, затем выберите Add folder.
Добавляйте элементы в папку или подпапку, перетаскивая их.

Удаление коллекции

Если коллекция больше не нужна, вы можете ее удалить.

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

Если удаленная коллекция больше 30 МБ, вы не сможете ее восстановить. Вы можете разделить содержимое коллекции на несколько меньших коллекций или создать резервную копию коллекции перед ее удалением.

Восстановление удаленной коллекции

Удаленные коллекции сохраняются и могут быть восстановлены в течение ограниченного периода времени в зависимости от вашего тарифного плана Postman . Коллекции, которые весят более 30 МБ, не могут быть восстановлены.

Выберите Trash в нижней части Postman.
Нажмите иконку восстановления рядом с коллекцией, которую вы хотите восстановить.

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

Откат изменений коллекции

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

Выберите иконку журнала изменений на правой боковой панели.
Выберите сессию, чтобы развернуть ее.
Нажмите иконку дополнительных действий рядом с изменением и выберите Restore to this change.

Коллекция возвращается в то состояние, в котором она была после выбранного изменения.

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

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

Вы можете поделиться коллекцией с другими пользователями Postman несколькими способами:

Выберите коллекцию в боковой панели, затем нажмите Share в рабочей области. Вы можете ввести имена пользователей, с которыми хотите поделиться коллекцией, или скопировать ссылку, чтобы отправить её другим. Узнайте больше о совместном использовании элементов в Postman.Чтобы поделиться ссылкой с пользователями, которые не входят в вашу команду Postman, включите Allow Guests, чтобы разрешить гостям присоединяться к вашей команде и просматривать эту коллекцию по ссылке. Узнайте больше о совместном использовании коллекций с гостевыми пользователями в вашей организации .
В рабочей области нажмите на иконку ссылки рядом с названием коллекции, чтобы скопировать ссылку в буфер обмена. Затем вы можете поделиться ссылкой с другими. Чтобы поделиться ссылкой на коллекцию, папку, запрос или пример с выбранной активной средой, выберите среду с помощью селектора сред и скопируйте ссылку на элемент в буфер обмена. Затем вы можете поделиться ссылкой с другими.
Переместите коллекцию в общее рабочее пространство. На боковой панели нажмите на иконку дополнительных действий рядом с коллекцией, затем выберите Move. Узнайте больше о перемещении элементов Postman .
Опубликуйте кнопку Run in Postman. Другие могут использовать кнопку Run in Postman для просмотра и запуска вашей коллекции в своей среде.
Если вы используете тарифный план Enterprise, вы можете добавить коллекцию в частную API сеть вашей команды .

Отслеживание коллекции

Если вы включите отслеживание коллекции, Postman будет уведомлять вас о любых изменениях, включая: добавление запроса или изменение запроса, добавление или обновление переменных, редактирование pre-request или post-response скриптов, а также добавление или удаление папок.

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

Чтобы включить отслеживание коллекции:

В боковой панели выберите Collections и выберите нужную коллекцию.
В рабочей области нажмите иконку отслеживания Watch.

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

Выберите иконку уведомлений в заголовке Postman.
Выберите View changelog, чтобы просмотреть список изменений, внесенных в коллекцию.

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

Чтобы просматривать изменения коллекции в любой момент, выберите коллекцию в боковой панели, а затем выберите иконку на правой боковой панели.

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

Добавление комментариев к коллекции

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

Выберите Collections на боковой панели и выберите нужную коллекцию.
Нажмите на иконку комментариев на правой боковой панели и введите свой комментарий.
(Необязательно) Установите флажок Watch collection, чтобы получать уведомления об изменениях в коллекции. Узнайте больше о том, как следить за коллекцией.
Выберите Comment, чтобы добавить свой комментарий.

Чтобы узнать больше об использовании комментариев для совместной работы над коллекциями и запросами, перейдите в раздел Комментирование коллекций, папок и запросов .

Тегирование коллекции

Тегирование коллекций доступно в планах Postman Enterprise. Вы можете применять общие теги к рабочим областям, коллекциям и API. Теги могут иметь длину от 2 до 64 буквенно-цифровых символов и должны начинаться с буквенного символа. Теги могут содержать дефисы, но не другие специальные символы или пробелы. Вы можете добавить до пяти тегов.

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

Чтобы узнать больше о поиске с использованием тегов в Postman, ознакомьтесь с документацией по поиску в Postman. Вы можете выполнять поиск по тегам в вашей частной API сети. Используйте теги для поиска элементов в вашей частной API сети. Вы также можете использовать теги для поиска элементов для добавления и элементов для запроса на добавление в вашу частную API сеть.

Чтобы добавить теги в коллекцию, выполните следующие действия:

Выберите Collections на боковой панели и выберите коллекцию.
Выберите раздел Tags, чтобы отредактировать его.

Выберите существующий тег или добавьте новый тег. Чтобы добавить новый тег, введите имя тега и выберите Create “имя тега” .

Чтобы сохранить изменения в тегах коллекции, выберите область вне секции Tags.

Чтобы удалить теги из коллекции, выполните следующие действия:

Выберите Collections на боковой панели и выберите нужную коллекцию.
Выберите раздел Tags, чтобы отредактировать его.
Нажмите на иконку закрытия рядом с тегом.

Чтобы сохранить изменения в тегах коллекции, выберите область вне секции Tags.

Создание форка коллекции

Если у вас нет прав на редактирование коллекции, вы можете внести изменения, создав форк коллекции в своем рабочем пространстве. Затем вы можете создать пулл-запрос, чтобы отправить ваши изменения в исходную коллекцию.

Чтобы создать форк коллекции, выполните следующие действия:

Выберите Collections на боковой панели и выберите коллекцию.
Нажмите на иконку форка в рабочем пространстве.

Чтобы узнать больше, перейдите в раздел Контроль версий для коллекций и окружений Postman.

Просмотр пулл-запросов, форков и сведений о коллекции

Чтобы получить более подробную информацию о коллекции, выберите коллекцию в боковой панели и выполните одно из следующих действий:

Чтобы просмотреть пулл-запросы для коллекции, выберите иконку пулл-запросов на правой боковой панели.
Чтобы просмотреть форки, созданные на основе коллекции, выберите иконку форка на правой боковой панели.
Чтобы увидеть больше информации о коллекции, включая мок-серверы, мониторы и интеграции, выберите иконку информации на правой боковой панели.

Перевод статьи «Organize and automate API requests in Postman Collections».