Как выполнить API-запрос через Swagger UI?

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

Ответ

Swagger UI (OpenAPI) предоставляет интерактивный интерфейс для тестирования API. Вот пошаговая инструкция:

1. Откройте нужную операцию API:

  • Перейдите к документации Swagger UI (обычно по адресу /swagger-ui.html, /swagger или /docs).
  • Найдите и разверните раздел с нужным эндпоинтом (например, POST /api/v1/login).

2. Нажмите кнопку "Try it out": Эта кнопка переводит блок описания в интерактивный режим для ввода параметров.

3. Заполните параметры запроса:

  • Path/Query параметры: Заполните поля в соответствующих input-полях. Они автоматически подставятся в URL.
  • Тело запроса (Request Body): Для методов POST/PUT отредактируйте JSON-схему в поле Example Value. Удалите комментарии и укажите ваши данные.
    {
      "username": "test_user",
      "password": "secure_pass_123"
    }

4. Выполните запрос: Нажмите кнопку Execute. Swagger отправит запрос к API.

5. Анализ ответа: После выполнения вы увидите:

  • cURL: Команда для повторения запроса из командной строки.
  • Request URL: Полный URL, который был отправлен.
  • Server response:
    • Code: HTTP-статус (200, 404, 500 и т.д.).
    • Body: Тело ответа от сервера в формате JSON/XML.
    • Headers: Заголовки ответа.

Важно: Если API требует авторизации, нажмите кнопку Authorize вверху страницы и введите токен (например, Bearer Token). Swagger будет автоматически добавлять его ко всем запросам.