Виджет позволяет вывести спецификацию API из файла в репозитории GitLab или по ссылке в формате OpenAPI (Swagger) или Protobuf. При выводе спецификации OpenAPI из файла в формате YAML или JSON виджет отображает интерфейс Swagger. Во всех остальных случаях виджет отображает спецификацию в виде текста.
Общая конфигурация
| Название | Обязательность | Описание | Возможные значения | Значение по умолчанию |
|---|---|---|---|---|
| Тип спецификации | Да | Тип спецификации | OpenAPI (Swagger), Protocol Buffers | — |
| Тип источника | Да | Тип источника, из которого будет загружаться файл со спецификацией | URL, GitLab | — |
Конфигурация типа источника: URL
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | Ссылка на файл со спецификацией | — |
| Заголовки | Нет | Заголовки для доступа к файлу со спецификацией | — |
Конфигурация типа источника: GitLab
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| GitLab URL | Да | URL GitLab | — |
| ID проекта | Да | Идентификатор проекта, из которого будет браться файл со спецификацией | — |
| Ветка | Да | Ветка, из которой будет браться файл со спецификацией | — |
| Путь к файлу | Да | Путь к файлу со спецификацией относительно корня репозитория | — |
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».