Продукты

Решения

Поддержка

Стать партнером

Новости

Получить Демо

Настройка Swagger

Примечание

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

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

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

Настройка на ОС Windows

1. Создайте файл DebugParams.xml в папке системы. Например, в папке C:\Windows\Temp.

   Предупреждение

   Доступ к папке не должен быть ограничен для пользователя.

2. Откройте файл 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">
       <DebugServerParams>
           <DisableWebApiSwagger>false</DisableWebApiSwagger>
       </DebugServerParams>
   </DebugParams>
   

   Сохраните изменения.

3. Переместите созданный файл в папку C:\Program Files\Macroscop Server.

4. Перезапустите приложение Macroscop Сервер.

5. Откройте Swagger по адресу http://host:port/webapi/swagger/index.html.

Настройка на ОС Linux

1. Завершите работу приложения Macroscop Сервер:

   sudo systemctl stop macroscop
   

2. Создайте файл DebugParams.xml в папке /opt/MacroscopServer с помощью команды:

   sudo touch /opt/MacroscopServer/DebugParams.xml
   

3. Откройте файл 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">
       <DebugServerParams>
           <DisableWebApiSwagger>false</DisableWebApiSwagger>
       </DebugServerParams>
   </DebugParams>
   

   Сохраните изменения.

4. Возобновите работу приложения Macroscop Сервер:

   sudo systemctl start macroscop
   

5. Откройте Swagger по адресу http://host:port/webapi/swagger/index.html.

Авторизация

Для авторизации в Swagger нажмите на кнопку Authorize в правой части экрана.

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

• Bearer

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

• Basic

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

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

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

• Не поддерживает авторизацию через Active Directory.

Примечание

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