Коллекции: папки, порядок, документирование
↑ 1.5 Postman: от установки до коллекций · ← Предыдущая · → Следующая
Зачем это аналитику и PM
Набор разрозненных вкладок нельзя отдать тестировщику и нельзя прогнать целиком. Коллекция с папками и короткими описаниями превращает удачные запросы в сценарий, который читается без автора.
План темы
- структура по сценариям
- описание запросов
- примеры ответов
- шаринг коллекции с командой
Объяснение
Коллекция — сохранённый набор запросов. Папка внутри неё группирует шаги одного сценария. Порядок в папке имеет смысл, если следующий запрос ждёт значение от предыдущего. Иначе порядок — только удобство чтения, и это лучше написать в описании.
Как оглавление опыта. Не «всё, что я нажимал», а «создать заказ», «оплатить», «посмотреть статус». Чужой человек открывает папку и идёт сверху вниз.
Структура и описания
Делите по сценарию или по ресурсу, но не по фамилии того, кто нажимал. Имя запроса говорит действие: «создать заказ», не «тест 3». В описании запроса хватает четырёх строк: зачем шаг, какой стенд подразумевается, какое поле важно в ответе, какой код считаем успехом. Длинную простыню никто не обновляет.
Пример ответа, если ваша версия умеет хранить его рядом с запросом, фиксирует один удачный и один неудачный разбор. Подпись кнопки сохранения примера сверьте на экране. Пример не заменяет схему: это один снимок. Секреты и живые персональные данные из снимка вырезают до того, как коллекция уйдёт дальше вас.
Как отдать команде
Общая коллекция живёт в рабочем пространстве, куда приглашены нужные люди. Файл экспорта — запасной путь, если у кого-то нет доступа в это пространство. Перед экспортом убедитесь, что в файле нет токенов. Описание «какой окружение выбрать» кладут в начало коллекции, иначе файл откроют на боевом адресе.
Права «кто может менять коллекцию» зависят от пространства и тарифа. Числа и роли здесь не приводятся: их смотрят в текущей справке Postman.
Примеры
Имена папки, которые уже можно передать:
Заказы
прочитать список
создать заказ
прочитать созданныйОписание у «создать заказ», схема:
Стенд берётся из переменной baseUrl.
Успех: код 201 и поле id.
Тело без токена. Допуск задаёт коллекция, не этот запрос.Нюансы и подводные камни
- Папка «разное» через месяц не читается. Имя папки должно быть сценарием.
- Пример ответа с боевым телом утекает вместе с коллекцией. Оставляйте учебные поля.
- Порядок запросов сам по себе не гарантирует, что второй дождётся первого, пока это не делает прогон. Вручную люди всё равно путают шаги.
- Копия коллекции на диске и копия в пространстве расходятся. Договоритесь, какая из них главная.
Практика
Сложите три учебных запроса в одну папку сценария. У каждого имя из глагола и объекта. У одного есть описание из четырёх коротких пунктов.
Ожидаемый результат: по именам понятен порядок истории без устных пояснений. В описании назван признак успеха. В тексте нет значения допуска.
Вопросы с ответами
Как делить папки?
По сценарию или по ресурсу, одинаково во всей коллекции. Деление по людям не переживает отпуск автора.
Пример ответа обязателен?
Нет, но один успешный и один отказ снимают спор «какое тело мы имели в виду». Снимок не должен содержать секреты и живых клиентов.
Как отдать коллекцию коллеге?
Лучше общим пространством. Файл экспорта — если иначе нельзя, и только после проверки, что в нём нет токенов. Напишите, какое окружение включить.
Порядок в папке всегда важен?
Он важен, когда шаг берёт данные предыдущего. Если запросы независимы, так и напишите, чтобы прогон не ждали как сюжет.