Как пользоваться Swagger?

C помощью Swagger вы можете тестировать методы Tinkoff Invest API. Cсылка на Swagger Tinkoff Invest API.

Что такое Swagger?

Swagger - это фреймворк для спецификации RESTful API. Один из его инструментов, Swagger UI, позволяет не только интерактивно просматривать спецификацию, но и отправлять запросы.

Что такое Swagger UI?

Swagger UI - один из самых популярных инструментов для создания интерактивной документации. Swagger UI создает интерактивную консоль API для экспериментов с запросами в реальном времени.

Инструкция по использованию

Авторизация

Прежде чем делать какие-либо запросы, нужна авторизация. Нажимаем кнопку Authorize и заполняем информацию, требуемую в окне «Авторизация», изображенном ниже:

В нашем случае необходимо ввести токен токен доступа. Подробнее о том, как получить токен можно узнать по ссылке: Токен доступа

Например: t.QtEo8ahkNFX4RTpbqp0u4z4GDZq27HzUp6AotJASBx7_DVqmqZMHfM2Cy7JmUjS80boI9eVg

Создание запроса

Теперь создадим запрос:

• Разворачиваем конечную точку
• Нажимаем кнопку Try it out

• После того, как мы нажмем кнопку Try it out, значение примера в поле «Тело запроса» станет редактируемым.

• В редактируемом поле изменяем значения параметров.

• Нажимаем Execute.

Пользовательский интерфейс Swagger отправляет запрос и показывает отправленный curl. Раздел Ответы показывает тело ответа и заголовки ответа.

Самый ожидаемый ответ, в случае правильной обработки запроса сервером, имеет код 200 и показывает то, как должна выглядеть структура ответа.

C помощью Swagger вы можете тестировать методы Tinkoff Invest API.

Официальную документацию вы можете найти на сайте Swagger.