Теория: Коллекции

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

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

Зачем нужны коллекции

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

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

Для создания новой коллекции выберите Collections в боковой панели

• Нажмите на знак + и выберите Blank collection из выпадающего списка
• Введите имя для вашей новой коллекции

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

Пока подробно мы остановимся на вкладках Overview и Authorization, а тесты и переменные рассмотрим в следующих уроках

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

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

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

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

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

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

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

Этот способ может быть полезным, если вы выполнили несколько запросов, а потом решили организовать их в коллекцию

• Нажмите на History в боковой панели
• Найдите запрос, который хотите добавить в коллекцию и нажмите значок + напротив него
• Выберите коллекцию и нажмите Save

Управление коллекциями

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

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

Создание директории

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

• Нажмите на значок ... и выберите Add folder. Дайте директории имя
• Перетащите нужные запросы в созданную директорию

Просмотр истории сделанных изменений

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

• Нажмите на значок ... и выберите View changelog, чтобы открыть историю изменений
• В открывшемся окне выберите нужное изменение, чтобы развернуть его

Совместная работа над коллекцией

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

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

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

• Нажмите Invite people

  

• Введите имя или email пользователя, которого хотите пригласить

• Выберите роль, которую хотите отвести приглашенному пользователю и нажмите Send Invite

  

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

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