Тестовый стенд: Swagger
Для наглядной проверки работы API прямо в браузере в LightDoc используется утилита Swagger.

На странице Swagger так же содержит информацию о методах и их параметрах.
В Swagger Вы без труда сможете вызывать тот или иной метод и получить "живой" ответ от системы

Ссылку на Swagger ищете на странице сервера
Чтобы получить доступ к исполнению методов API необходимо пройти авторизацию с использованием токена

Просмотр методов API
  1. Для просмотра выбранного метода API разверните его карточку нажатием на название в списке методов

2. На карточке метода в разделе Example Value можно увидеть пример тела запроса

Для просмотра схемы запроса нажмите соответствующую кнопку Schema

Авторизация


1. Нажмите кнопку Authorize

2. В появившемся диалоговом окне введите полученный токен доступа API с префиксом "Bearer" разделенные одним знаком пробела

Строка будет иметь формат Bearer {{токен доступа к API}}

Нажмите зеленую кнопку Authorize на форме, поле ввода заблокируется

Закройте форму нажатием кнопки Close



3. Проверьте что на зленой кнопке Authorize справа поменялась иконка на закрытый замок

Запуск метода API

1. Нажмите кнопку Try it out справа

После нажатия становятся доступным ввод параметров для вызова


Внимание. Для запуска должна быть выполнена Авторизация. Проверьте что иконка замка закрыта и ключ API введен корректно. См. пункт выше.❗



2. Введите значения параметров исполняемого метода и запустите выполнение метода нажатием кнопки Execute

3. В разделе Resposes карточки метода появится результат выполнения

Request URL - полный адрес исполняемого метода

Code - код стандартного http ответа REST

Response body - тело ответа в формате JSON

В блоке Сurl можно посмотреть пример запуска метода консольной утилитой curl