Skip to content

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

Для установки с Docker

  1. Откройте файл /opt/hw-vmp/config/user.ini

  2. Добавьте параметр v.engine.swagger.ui.enabled = on в раздел [main]

  3. Чтобы применить изменения, выполните команду: /opt/hw-vmp/bin/reconfig

  4. Документация Swagger UI будет доступна по адресу https://<vampi_hostname>/api/ui/

Для установки в Kubernetes кластере

  1. В файле значений Helm-чарта Vampy найдите секцию vEngine.swaggerUI и установите параметр enabled: on, например:

    vEngine:
      swaggerUI:
        enabled: on
    
  2. Примените изменения, обновив релиз Helm:

    helm upgrade $RELEASE_NAME oci://registry.hexway.io/charts/vampy \
      --version $RELEASE_VERSION \
      -n $RELEASE_NAMESPACE \
      -f my-values.yaml
    
  3. После применения изменений документация Swagger UI будет доступна по адресу https://<ingress_hostname>/api/ui/ (в соответствии с настроенным Ingress/host для Vampy).