Тестовый стенд. Утилита Swagger
Для проверки работы API прямо в браузере в LightDoc используется утилита Swagger. На странице Swagger так же содержит информацию о методах и их параметрах. В Swagger Вы без труда сможете вызывать тот или иной метод, получить ответ от системы и проанализировать взаимодействие. Актуальная ссылка на Swagger тестового стенда есть на странице с адресами серверов API.
Чтобы получить доступ к исполнению методов API необходимо пройти авторизацию с использованием токена.
❗Для получения доступа к API и генерации токена на тестовом стенде обратитесь в техподдержку LightDoc! Доступ предоставляется бесплатно!
Просмотр методов API #
- Для просмотра выбранного метода API разверните его карточку нажатием на название в списке методов
- На карточке метода на вкладке «Example Value» можно увидеть пример тела запроса.
Для просмотра схемы запроса нажмите перейдите на вкладку «Schema».
Авторизация #
- Нажмите кнопку Authorize;
- В появившемся диалоговом окне введите полученный токен доступа API с префиксом «Bearer» разделенные одним знаком пробела;
- Строка будет иметь формат Bearer {{токен доступа к API}}.
Нажмите зеленую кнопку «Authorize» на форме, поле ввода заблокируется.
Закройте форму нажатием кнопки «Close»; - Проверьте что на зеленой кнопке «Authorize» справа поменялась иконка на закрытый замок;
Запуск метода API #
- Нажмите кнопку «Try it out» справа
После нажатия становятся доступным ввод параметров для вызова
❗ Внимание. Для запуска должна быть выполнена Авторизация. Проверьте что иконка замка закрыта и ключ API введен корректно. См. пункт выше. - Введите значения параметров исполняемого метода и запустите выполнение метода нажатием кнопки «Execute»
- В разделе Resposes карточки метода появится результат выполнения
Request URL — полный адрес исполняемого метода
Code — код стандартного http ответа REST
Response body — тело ответа в формате JSON
В блоке Сurl можно посмотреть пример запуска метода консольной утилитой curl