Программные интерфейсы

спринт Программные интерфейсы
Компьютерная сеть и протоколы
6/6
О чём этот спринт
Сетевая модель OSI
Сетевая модель TCP/IP
HTTP-запрос
Параметры HTTP-запроса
HTTP-ответ
Стили представления данных
2/2
JSON
XML
Postman
2/2
Postman: основная функциональность
Postman: тестирование API
Стили взаимодействия
4/4
Проектирование взаимодействия
1/1
Воркшоп и домашнее задание
1/2
Заключение
1/1

Postman: тестирование API

В прошлом уроке вам удалось познакомиться с Postman, отправить запросы в API и посмотреть ответы сервера. Теперь вы потренируетесь тестировать API приложения Яндекс Прилавок с помощью Postman.
Представьте, что разработчики API передали вам на тестирование новую функциональность:
  • Получить список наборов, которые содержатся в карточке.
  • Создать пустой набор с продуктами.
  • Получить список наборов, в которых есть переданные в запросе продукты.
  • Получить список продуктов, которые входят в набор.
Изучите требования тут.
Ваш коллега-тестировщик уже подготовил тестовые данные — проверить функциональность нужно на примере карточки «Под ситуацию».
Используйте чек-лист:
  1. При отправке запроса GET /api/v1/kits?cardId=1 в ответе возвращается список наборов, привязанных к карточке.
  2. При отправке запроса POST /api/v1/kits с cardId и name создаётся пустой набор, привязанный к карточке.
  3. При отправке запроса POST /api/v1/products/kits с указанными id продуктов в ответ приходит список наборов, в которых содержатся эти продукты.
  4. При отправке запроса GET /api/v1/kits/search?name=В+космос в ответ приходит список продуктов для заданного набора.
  1. Запустите сервер с API из предыдущего урока.
  2. Откройте Postman. Создайте новый запрос и скопируйте адрес сервера в URL.
Теперь можно выполнять проверки по чек-листу.
При отправке запроса GET /api/v1/kits?cardId=1 в ответе возвращается список наборов, привязанных к карточке «Под ситуацию».
Адрес сервера у вас уже подставлен. Теперь нужно добавить к адресу URL /api/v1/kits?cardId=1. URL можно найти в требованиях.
Запрос принимает на вход параметр cardId с номером карточки, содержимое которой нужно посмотреть. В этом примере вы запрашиваете список наборов в карточке «Под ситуацию», поэтому нужно знать её номер.
Информацию о параметрах запроса можно найти в документации к API. Документация описывает, как работает API: например, какие запросы может принимать и какие ответы отправлять. Вы научитесь работать с ней в следующих уроках.
Пока можете посмотреть выдержку из документации с параметрами запроса GET /api/v1/kits:
Из предыдущего урока вы уже знаете, как создавать параметры в запросе.
  1. Создайте параметр cardId и подставьте значение 1 — это номер карточки «Под ситуацию». Она уже есть в приложении.
  2. Отправьте запрос в API.
Какие код и тело ответа сервера удалось получить?
Должно получиться так:
Сохраните запрос.
Для этого:
  1. В области работы с запросом кликните по кнопке Save («Сохранить»). Появится окно сохранения запроса.
  2. В поле Request name («Имя запроса») введите название запроса. Например, «Получить список наборов в карточке».
  3. В поле Select a collection or folder to save («Выбрать коллекцию или папку для сохранения») нажмите Create collection («Создать коллекцию»).
  4. Создайте новую коллекцию Practicum.
Коллекция — это место хранения ваших запросов в Postman. Ещё в коллекции можно группировать и сортировать запросы. Подробнее о коллекциях можно прочитать тут.
При отправке запроса POST /api/v1/kits с cardId и name создаётся пустой набор, привязанный к карточке
По документации к API, чтобы создать набор, нужно в теле запроса передать номер карточки (параметр cardId) и название набора (параметр name) в формате JSON.
  1. Подставьте в запрос уже известную вам карточку «Под ситуацию»: cardId = 1.
  2. Новый набор с продуктами назовите «В космос»: name = "В космос".
Пример тела запроса из документации:
JSON
{
    "cardId": 1, 
    "name": "В космос" 
}
  1. В URL после адреса стенда добавьте путь /api/v1/kits.
  2. Отправьте запрос.
Какие код и описание ответа сервера удалось получить?
Проверьте, что в списке наборов карточки «Под ситуацию» есть набор «В космос». В теле ответа ищите название набора по name.
При отправке запроса POST /api/v1/products/kits с указанными id продуктов в ответ приходит список наборов, содержащих эти продукты
Иногда методом POST можно не только создавать, но и получать данные. По документации к API в теле запроса передаётся параметр ids в формате JSON. ids — это массив, содержащий список идентификаторов id продуктов.
В базе данных приложения уже лежат продукты для тестирования. Возьмите вот эти:
  • 1 — id продукта Orange Juice - Cold-Pressed, No Added Sugar, Preservative Free;
  • 22 — id продукта Pepperoni.
Вот пример тела запроса из документации:
JSON
{
    "ids": [
        1,
        22
    ]
}
Создайте и отправьте новый запрос.
Какой ответ сервера удалось получить?
Сохраните запрос под именем «Получить список наборов по продуктам».
При отправке запроса GET /api/v1/kits/search в ответ приходит список продуктов для заданного набора
Запрос принимает на вход параметр name с названием набора. Вы уже умеете добавлять параметры в URL запроса. В качестве name используйте набор «В космос». В ответ должен прийти список продуктов или пустой ответ, если в наборе пока нет продуктов.
Обратите внимание, в URL можно передать только ограниченный набор символов, поэтому пробел в параметрах запроса заменяется либо на %20, либо на +: В%20космос или В+космос.
Создайте и отправьте новый запрос. Что пришло в ответ?
Сохраните запрос под именем «Получить список продуктов по имени набора».
Теперь вы знаете, как в Postman тестировать API по чек-листу и сравнивать ожидаемый результат с фактическим.