Поддержка OpenAPI и Swagger¶
API Продукта поддерживает спецификацию OpenAPI. Для генерации метаданных OpenAPI используется Swagger. Для облегчения разработки, тестирования и внедрения используется SwaggerUI.
SwaggerUI¶
Для доступа к странице SwaggerUI в браузере нужно указать URL одного из развернутых HTTP-сервисов Продукта, после чего браузер автоматически будет перенаправлен на страницу SwaggerUI. Эта страница содержит подробное описание всех доступных запросов к API и структур данных. Здесь же можно загрузить JSON-файл с метаданными OpenAPI.
Аутентификация и авторизация в SwaggerUI¶
Выполнение запросов в SwaggerUI требует аутентификации и авторизации пользователя.
Нужно зайти в раздел Авторизация, пользователи и роли, открыть POST-запрос token («Получить токен»), нажать Try it out:
Затем в поле Request body указать логин и пароль пользователя (см. Учетные записи по умолчанию) и нажать Execute:
Затем скопировать токен из ответа:
Затем наверху страницы нажать Authorize:
Затем в открывшейся форме вставить скопированный токен в поле Value и нажать Authorize, после нажать Close:
Выполнение запросов в SwaggerUI¶
Для выполнения запросов в SwaggerUI нужно найти требуемый раздел в списке либо с помощью поиска.
Затем зайти в раздел, открыть требуемый запрос в разделе, нажать Try it out:
Затем задать параметры запроса в списке Parameters и/или тело запроса в поле Request body и нажать Execute:
Ответ сервера будет доступен в поле Server response:
