Skip to main content

Попробуйте API в Swagger

Swagger UI — это мощный и интуитивно понятный инструмент для тестирования API прямо в вашем браузере. Он позволяет отправлять запросы, исследовать доступные методы и просматривать ответы — всё это без написания кода. TargPatrol предоставляет Swagger для быстрого и удобного тестирования API.

Почему стоит использовать Swagger?​

  • Интуитивный интерфейс: Легко просматривать все доступные конечные точки и их параметры.
  • Быстрое тестирование: Отправка запросов и получение ответов в реальном времени.
  • Централизованная документация: Доступ ко всем описаниям конечных точек в одном месте.
  • Экономия времени: Нет необходимости писать код для тестирования API запросов.

Как начать работу с Swagger для TargPatrol​

Шаг 1: Открыть Swagger​

Перейдите по ссылке Swagger TargPatrol.

Swagger

Шаг 2: Исследовать доступные конечные точки​

На главной странице Swagger вы найдете классифицированный список всех доступных методов.

Шаг 3: Настройка авторизации​

Для отправки аутентифицированных запросов:

  1. Нажмите кнопку Authorize в правом верхнем углу.
  2. Введите свой личный API токен в предоставленное поле.
  3. Нажмите Authorize и закройте окно.

Swagger Auth

Шаг 4: Тестирование API​

  1. Выберите конечную точку, которую хотите протестировать.
  2. Нажмите на нее, чтобы открыть детали.
  3. Заполните необходимые параметры запроса.
  4. Нажмите Execute.

Swagger Request

Swagger отобразит:

  • Полный сформированный запрос.
  • Статус ответа (например, 200 OK).
  • Содержимое ответа API.