Как включить Swagger

Функционал доступен для версии платформы 2.3.2 и выше. По умолчанию Swagger платформы Штурвал всегда запущен.

Чтобы проверить доступность Swagger, перейдите по адресу back.apps.<ingress>/swagger/index.html, где вместо <ingress> подставьте значение вашего VIP или FQDN, использованного в платформе.

Если страница Swagger платформы Штурвал недоступна, выполните шаги по его запуску:

  1. Перейдите в Платформа/Сервисы и репозитории/Установленные сервисы.
  2. Найдите Модуль программного управления Платформой. Нажмите Управлять.
  3. В спецификации сервиса добавьте строку или измените значение на true для параметра EnableSwagger:
EnableSwagger: True
  1. Сохраните изменения спецификации модуля и Swagger будет запущен.

Чтобы авторизоваться в Swagger необходимо получить токен. Для этого вы можете воспользоваться графическим интерфейсом платформы Штурвал:

  1. Откройте консоль разработчика, когда находитесь на любой странице, нажав правой кнопкой мыши и выбрав “Просмотреть код” в Google Chrome или “Исследовать” в Mozilla Firefox.

  2. Обновите страницу.

  3. В разделе Network(Сеть) выберите последний запрос и открыть Headers.

  4. Скопируйте значение поля Authorization, значение после Bearer.

  5. Перейдите по адресу back.apps.<ingress>/swagger/index.html, где вместо <ingress> подставьте значение вашего VIP или FQDN, использованного в платформе.

  6. В Schemas выберите HTTPS.

  7. Нажмите Authorize и вставьте скопированное значение.

Swagger готов к использованию.

← Создать кластер с внешним etcd