Настройка Swagger

Примечание

Начиная с Macroscop версии 4.2 стал доступен инструмент для просмотра и выполнения запросов Swagger.

По умолчанию просмотр в браузере веб-интерфейса Swagger недоступен для устанавливаемого дистрибутива.

Для настройки отображения Swagger необходимо выполнить следующие шаги:

1. Прописать следующую строку в файле C:/Program Files/ Macroscop Сервер /DebugParams.xml для включения опции отображения Swagger.

   <DisableWebApiSwagger>false</DisableWebApiSwagger>
   

   Пример записи в файл DebugParams.xml

   <?xml version="1.0"?>
   <DebugParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
       <DebugVisualizationParams>
           <EnableDebugLogging>false</EnableDebugLogging>
           <GlobalRenderSleepTimeMs>8</GlobalRenderSleepTimeMs>
           <DisableGlobalRenderThread>false</DisableGlobalRenderThread>
           <SaveOnDisk>false</SaveOnDisk>
           <DelayMs>130</DelayMs>
           <DelayQueueSize>6</DelayQueueSize>
           <DelayMinDequeueIntervalMs>24</DelayMinDequeueIntervalMs>
           <EnableHighIppScaleQuality> false </EnableHighIppScaleQuality>
           <DisableClientProblemNotifications> false </DisableClientProblemNotifications>
           <MulticastReceiveBufferSizeInBytes>0</MulticastReceiveBufferSizeInBytes>
       </DebugVisualizationParams>
       <DebugServerParams>
           <DisableSsl>false</DisableSsl>
           <DisablePerformanceCounters>false</DisablePerformanceCounters>
           <DisableStreamStatistic>false</DisableStreamStatistic>
           <DisableWebApiSwagger>false</DisableWebApiSwagger>
       </DebugServerParams>
       <DebugLoggerParams>
           <DisableErrorLogOpening>false</DisableErrorLogOpening>
           <EnableLogArchiveDeletingFiles>false</EnableLogArchiveDeletingFiles>
           <MaxLogSize>100</MaxLogSize>
           <MaxFileSize>3</MaxFileSize>
           <MaxSizeRollBackups>2</MaxSizeRollBackups>
       </DebugLoggerParams>
   </DebugParams>
   

2. Перезапустить Macroscop Сервер.

3. Открыть Swagger по адресу https://host:port/webapi/swagger/index.html.

Аутентификация

Web-интерфейс Swagger поддерживает следующие методы аутентификации:

1. Basic

   Заголовок Authorization (Basic логин:пароль)

2. JWT

   Заголовок Authorization (Bearer token)

Особенности интерфейса Swagger

1. Не поддерживает передачу данных аутентификации через URL

2. Не поддерживает аутентификацию через Active Directory.

Примечание

Запросы, описанные в документации Swagger, поддерживают указанные методы аутентификации.