Знакомство с Postman: кто ещё бывает клиентом

Что такое API и endpoint, почему клиент — не только браузер и зачем тестировщику Postman. А ещё: чем path-параметры отличаются от query-параметров и что есть в окне Postman.

О продукте

Алекс, QA-тимлид

Привет! Есть новая задача. Команда переделывает каталог BB Food: сервер с новым API уже готов, а страницу каталога фронтенд-разработчики ещё делают. Проверить API нужно уже сейчас.

Справка по теме

API

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

Endpoint

Один конкретный пункт API: метод вместе с путём, например GET /api/v1/products. Полный адрес — это базовый адрес (base URL) плюс путь. Один путь с разными методами — это разные endpoint’ы. Все они описаны в документации API, часто в Swagger, который обычно генерируется автоматически по коду бэкенда.

Кто может быть клиентом

Клиент — любая программа, которая отправляет запрос серверу: браузер, мобильное приложение или Postman. Сервер видит только запрос и отвечает на одинаковые запросы одинаково.

Postman

Программа для отправки запросов к API вручную. Показывает ответ как есть: код статуса, время, размер, заголовки и тело. Браузер же рисует из ответа страницу.

Зачем тестировщику запросы мимо интерфейса

Проверить API, пока страницы ещё нет; понять, где баг — на клиенте или на сервере; отправить данные, которые форма не пропустит; быстрее повторять проверки.

Path- и query-параметры

Path-параметр — часть пути и выбирает конкретный ресурс: /api/v1/products/5. Query-параметры идут после ? парами ключ=значение через & и уточняют запрос: /api/v1/products?category=bread&sort=price.

Окно Postman

Строка запроса (метод, адрес, Send), вкладки Params, Authorization, Headers, Body и Scripts, панель ответа. Слева — коллекции, окружения и история.

Коллекции и окружения

Коллекция — сохранённые запросы по папкам, ими можно делиться с командой. Окружение хранит переменные, например {{baseUrl}}: переключил окружение — запросы ушли на другой сервер.