< H / $ > Хак/Собесов

Перейти на PRO

Как выглядит пример ответа API, описанного в Swagger/OpenAPI?

«Как выглядит пример ответа API, описанного в Swagger/OpenAPI?» — вопрос из категории API тестирование, который задают на 10% собеседований QA Тестировщик. Ниже — развёрнутый ответ с разбором ключевых моментов.

Тип вопроса: API тестирование Вероятность: 10% Категория: QA Тестировщик

Ответ

В Swagger/OpenAPI спецификации пример ответа API (Response Example) демонстрирует структуру и типы данных, которые возвращает эндпоинт. Обычно это валидный JSON-объект.

Пример ответа для GET /api/v1/products/{id}:

{
  "id": 12345,
  "name": "Смартфон Example X",
  "price": 599.99,
  "currency": "USD",
  "inStock": true,
  "attributes": {
    "color": "черный",
    "storage": "128GB"
  },
  "tags": ["electronics", "mobile", "new"],
  "createdAt": "2024-01-15T10:30:00Z"
}

Разбор структуры ответа:	Элемент	Пример	Тип данных / Назначение
Простое поле	`"id": 12345`	Число (integer), уникальный идентификатор.
Строка	`"name": "Смартфон..."`	Строка (string).
Число с плавающей точкой	`"price": 599.99`	Число (number/float).
Булево значение	`"inStock": true`	Логический флаг (boolean).
Вложенный объект	`"attributes": { ... }`	Объект (object) для группировки связанных полей.
Массив	`"tags": [ ... ]`	Список значений (array).
Дата-время	`"createdAt": "..."`	Строка в формате ISO 8601 (date-time).

Такой пример используется для:

Документации для разработчиков.
Валидации реальных ответов сервера.
Настройки мок-серверов (Mock Server) на этапе разработки.