Как загружать файлы и отправлять JSON в Postman: полное руководство

Для кого эта статья:

• Специалисты по тестированию программного обеспечения (QA)
• Разработчики API и программисты

• Ученики и студенты на курсах по тестированию и автоматизации

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

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

Основы загрузки файлов и JSON в Postman

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

При работе с API часто требуется отправлять различные типы данных: текст, JSON-объекты, файлы или их комбинации. Postman поддерживает все эти сценарии, предоставляя разные способы формирования запросов:

• form-data — для отправки файлов и текстовых данных
• x-www-form-urlencoded — для отправки данных в формате ключ-значение
• raw — для отправки текста, включая JSON, XML, HTML
• binary — для отправки бинарных данных
• GraphQL — для запросов к GraphQL API

Ключевое отличие заключается в том, как Postman формирует заголовок Content-Type в зависимости от выбранного способа. Например, при выборе raw с JSON, заголовок будет установлен как application/json, а при использовании form-data — как multipart/form-data.

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

Алексей, Lead QA Engineer Помню свой первый проект по тестированию API системы документооборота. Мне нужно было загрузить PDF-файлы вместе с метаданными в JSON. Я потратил целый день, пытаясь сделать это через raw-режим, не понимая, почему сервер отклоняет мои запросы. Оказалось, я неправильно понимал саму концепцию multipart/form-data.

Поворотным моментом стало осознание того, что form-data — это не просто "форма", а специальный формат, который позволяет объединять произвольные типы данных в одном запросе. После этого я создал ментальную карту всех типов запросов в Postman и больше никогда не путался. Теперь это первое, что я объясняю новым тестировщикам в команде.

Важно также учитывать ограничения серверной части. Не все API поддерживают multipart/form-data или имеют ограничения на размер загружаемых файлов. Перед началом работы стоит изучить документацию тестируемого API.

Настройка загрузки файлов через form-data в Postman

Загрузка файлов в Postman реализуется преимущественно через form-data, поскольку этот формат специально разработан для передачи как текстовых данных, так и файлов. Рассмотрим процесс настройки шаг за шагом. 🗂️

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

1. Создайте новый запрос или откройте существующий
2. Выберите HTTP-метод (обычно POST, PUT или PATCH для загрузки)
3. Введите URL-эндпоинта
4. Перейдите во вкладку "Body"
5. Выберите опцию "form-data"
6. Добавьте новый ключ (параметр) для файла
7. В выпадающем списке рядом с ключом выберите "File" вместо "Text"
8. Нажмите "Select File" и выберите файл для загрузки

После выбора файла Postman покажет имя файла в поле значения. Теперь при отправке запроса файл будет передан на сервер как часть multipart/form-data запроса.

При работе с form-data важно правильно называть ключи. Серверная часть ожидает определенные имена параметров для файлов. Обычно это "file", "document", "image" или другие специфичные для API названия.

Мария, QA Automation Engineer На одном из проектов мы тестировали API для загрузки медицинских изображений. Документация была скудной, и никто не мог понять, почему загрузка не работает, хотя код запроса выглядел правильно. После нескольких часов дебаггинга я обратила внимание на одну деталь — сервер ожидал, что ключ для файла будет называться не просто "file", а "file[]" (с квадратными скобками), поскольку предполагалась возможность множественной загрузки. Мы поменяли имя параметра, и всё заработало. С тех пор я всегда внимательно проверяю точные названия параметров в документации и использую инструменты перехвата трафика, чтобы видеть, какие именно данные отправляются в запросе. Это сэкономило команде огромное количество времени на последующих проектах.

При загрузке файлов могут возникать различные проблемы. Вот наиболее распространенные из них и способы их решения:

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

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

pm.variables.get("filePath")

А затем в пре-запросном скрипте установите значение переменной:

pm.variables.set("filePath", "/path/to/your/file.jpg");

Этот подход особенно полезен при запуске тестов в разных окружениях или при использовании CI/CD систем.

Работа с JSON-данными в запросах Postman

JSON (JavaScript Object Notation) является одним из самых распространенных форматов обмена данными в API. Postman предоставляет несколько эффективных способов работы с JSON-данными в ваших запросах. 📊

Для отправки JSON-данных в Postman следуйте этому алгоритму:

1. Создайте новый запрос или откройте существующий
2. Перейдите во вкладку "Body"
3. Выберите опцию "raw"
4. В выпадающем списке справа выберите "JSON"
5. Введите JSON-данные в текстовое поле

При выборе формата JSON, Postman автоматически устанавливает заголовок Content-Type: application/json, что является стандартом для JSON-взаимодействия.

Postman предлагает удобное форматирование и подсветку синтаксиса JSON, что значительно упрощает работу с данными. Вы можете использовать комбинацию клавиш Ctrl+B (или Cmd+B на Mac) для автоматического форматирования JSON-кода.

Важный аспект работы с JSON в Postman — использование переменных. Вместо хардкода значений, эффективнее использовать динамические переменные:

{
"userName": "{{username}}",
"password": "{{password}}",
"settings": {
"notificationsEnabled": {{notificationsEnabled}}
}
}

Переменные могут быть определены на разных уровнях:

• Глобальные — доступны во всех коллекциях
• Коллекции — доступны в пределах коллекции
• Окружения — зависят от выбранного окружения
• Локальные — создаются в пре-запросных скриптах и сценариях тестов

Для сложных JSON-структур Postman предлагает несколько полезных техник:

1. Импорт JSON из файла: напишите пре-запросный скрипт, который загружает JSON из файла
2. Генерация JSON на лету: используйте JavaScript для создания динамических структур
3. Манипуляция с JSON: преобразуйте, фильтруйте или объединяйте JSON-объекты

Для работы с JSON-ответами от API, Postman предоставляет мощные инструменты парсинга и валидации:

pm.test("Проверка структуры ответа", function () {
var jsonData = pm.response.json();
pm.expect(jsonData).to.have.property('id');
pm.expect(jsonData.name).to.eql('Test User');
});

При работе с большими JSON-структурами рекомендую использовать JSONPath для навигации по данным:

var jsonData = pm.response.json();
var specificValue = jsonData.users[0].addresses[1].zipCode;

Также полезно знать о распространенных проблемах при работе с JSON в Postman:

Для оптимизации работы с JSON в автоматизированных тестах, рекомендуется создавать шаблоны JSON-объектов и хранить их в переменных окружения или коллекции. Это упрощает сопровождение и масштабирование тестов.

Комбинирование файлов и JSON в одном API-запросе

Одна из наиболее сложных задач при работе с Postman — отправка в одном запросе как файлов, так и структурированных JSON-данных. Эта потребность возникает во многих API: от загрузки документов с метаданными до систем электронного документооборота. 🔄

Существует несколько подходов к решению этой задачи, каждый со своими преимуществами и ограничениями:

1. Использование form-data с текстовыми полями для JSON — наиболее распространенный подход
2. Отправка JSON как строки с последующим парсингом на сервере — подходит для простых структур
3. Использование multipart/mixed Content-Type — для специфических API
4. Применение URL-параметров для метаданных — ограниченный, но простой подход

Рассмотрим первый и самый универсальный подход — использование form-data с комбинацией типов полей:

1. Создайте новый запрос и выберите метод POST
2. Перейдите во вкладку "Body" и выберите "form-data"
3. Добавьте ключ для файла (например, "file") и выберите тип "File"
4. Добавьте ключ для JSON-данных (например, "metadata") и оставьте тип "Text"
5. В поле значения для "metadata" введите ваш JSON в виде строки

Пример значения для поля "metadata":

{
"title": "Отчет за квартал",
"department": "Финансовый",
"tags": ["квартальный", "финансы", "2023"],
"confidential": true
}

Обратите внимание на синтаксис JSON — он должен быть валидным, поскольку сервер будет парсить эту строку.

Для удобства формирования JSON в текстовом поле можно сначала написать и проверить его в редакторе JSON, а затем скопировать в поле form-data. Если JSON содержит кавычки, убедитесь, что они правильно экранированы.

Более сложный, но гибкий подход — использование пре-запросных скриптов для динамического формирования данных:

// Создаем объект метаданных
const metadata = {
title: pm.variables.get("documentTitle"),
department: "HR",
createdAt: new Date().toISOString()
};

// Устанавливаем строковое представление JSON как переменную
pm.variables.set("metadataJson", JSON.stringify(metadata));

Затем в form-data используйте переменную:

{{metadataJson}}

Важно понимать, что не все API поддерживают такой формат. Некоторые требуют специфической структуры данных:

• Некоторые API ожидают JSON в поле с именем "json"
• Другие требуют, чтобы метаданные были закодированы в формате URL-encoded
• Третьи могут ожидать, что каждое поле метаданных будет отдельным полем формы

Если API требует, чтобы каждое поле JSON было отдельным полем формы, используйте JavaScript для динамического создания полей:

const metadata = {
title: "Документ",
category: "Контракт",
expiration: "2023-12-31"
};

// Для каждого поля метаданных создаем отдельную переменную
Object.keys(metadata).forEach(key => {
pm.variables.set(`metadata_${key}`, metadata[key]);
});

Затем в form-data добавьте отдельные поля:

• metadatatitle: {{metadatatitle}}
• metadatacategory: {{metadatacategory}}
• metadataexpiration: {{metadataexpiration}}

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

• user.name: John Doe
• user.email: john@example.com
• permissions
• permissions

Это позволит серверу реконструировать вложенную структуру данных.

Автоматизация тестирования API с файлами в Postman

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

Первый шаг — организация файлов для тестирования. Рекомендуется создать специальную структуру папок:

• test_files/ — корневая папка для тестовых файлов
• test_files/images/ — изображения разных форматов и размеров
• test_files/documents/ — документы (PDF, DOCX и т.д.)
• test_files/invalid/ — некорректные файлы для негативного тестирования

Для эффективной автоматизации необходимо параметризовать пути к файлам, используя переменные окружения:

// В переменных окружения:
{
"TEST_FILES_PATH": "/path/to/your/test_files",
"VALID_IMAGE": "/images/test_image.jpg",
"VALID_DOCUMENT": "/documents/sample.pdf",
"OVERSIZED_FILE": "/invalid/huge_file.zip"
}

В пре-запросном скрипте можно сформировать полный путь к файлу:

// Формируем абсолютный путь к файлу
const basePath = pm.environment.get("TEST_FILES_PATH");
const filePath = basePath + pm.environment.get("VALID_IMAGE");

// Устанавливаем путь для текущего запроса
pm.variables.set("currentFilePath", filePath);

Для комплексного тестирования API с файлами, создайте коллекцию тестов, охватывающую различные сценарии:

1. Базовый сценарий успешной загрузки с валидными данными
2. Пограничные случаи (минимальный/максимальный размер файла)
3. Негативные сценарии (недопустимые форматы, поврежденные файлы)
4. Проверка ограничений безопасности (попытки загрузки исполняемых файлов)
5. Тестирование производительности при загрузке больших файлов

Автоматизация проверок ответов API является ключевой частью процесса. Вот пример скрипта для проверки успешной загрузки файла:

pm.test("Статус ответа: 200", function () {
pm.response.to.have.status(200);
});

pm.test("Файл успешно загружен", function () {
var jsonData = pm.response.json();

pm.expect(jsonData).to.have.property('success');
pm.expect(jsonData.success).to.be.true;

pm.expect(jsonData).to.have.property('fileId');
pm.expect(jsonData.fileId).to.be.a('string');

// Сохраняем ID файла для последующих запросов
pm.environment.set("uploadedFileId", jsonData.fileId);
});

pm.test("Проверка метаданных файла", function () {
var jsonData = pm.response.json();

pm.expect(jsonData).to.have.property('metadata');
pm.expect(jsonData.metadata.originalName).to.eql(pm.variables.get("fileName"));
pm.expect(jsonData.metadata.size).to.be.above(0);
});

Для эффективной отладки автоматизированных тестов с файлами, используйте консоль Postman:

console.log("Тестируем загрузку файла: " + pm.variables.get("currentFilePath"));
console.log("Размер ответа: " + pm.response.size().body + " байт");
console.log("Заголовки ответа: ", pm.response.headers.all());

Integrating file uploads into CI/CD pipelines requires additional considerations:

Для запуска тестов в командной строке используйте Newman — CLI-инструмент для Postman:

newman run your_collection.json -e your_environment.json --folder "File Upload Tests"

Для более сложных сценариев автоматизации, разделите тесты на модули по функциональности:

• 1fileupload — базовая загрузка файлов
• 2metadatavalidation — проверка метаданных загруженных файлов
• 3fileprocessing — тесты обработки файлов (сжатие, преобразование)
• 4permissiontests — проверка прав доступа к файлам
• 5_cleanup — удаление тестовых данных

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

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