Configuring Swagger🔗

Note

Starting with Eocortex version 4.2, the Swagger tool for viewing and executing queries has become available.

By default, browser viewing of the Swagger web interface is not available for the distribution being installed.

To configure the Swagger display, follow these steps:

  1. Write the following line in C:/Program Files/ Eocortex Server /DebugParams.xml to enable the Swagger display option.

    <DisableWebApiSwagger>false</DisableWebApiSwagger>.

    Example of writing to the DebugParams.xml file

    <?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. Restart Eocortex Server.

  3. Open Swagger at https://host:port/webapi/swagger/index.html.

Authentication🔗

The Swagger Web interface supports the following authentication methods:

  1. Basic

    Authorization header (Basic login:password)

  2. JWT

    Authorization header (Bearer token)

Features of the Swagger interface:

  1. Doesn't support passing authentication data through URLs

  2. Doesn't support authentication through Active Directory.

Note

The queries described in the Swagger documentation the specified authentication methods.