apiDiscovery - Обнаружение API (apiDiscovery)

Конфигурация функции обнаружения API для предоставления документации по API REST.

NameTypeDefaultDescription
maxSubscriptionsint
Min: 0

Max: 100
20Задает максимальное число клиентов API REST, которые одновременно могут получать обновления.
apiNamestringИмя объединенного API.
publicURLstring/apiЗадает корневой контекст для конечных точек общедоступной документации по API. В URL не требуется прямая косая черта (/).
swaggerDefinitionstringРасположение файла, URL для JSON, фрагмент кода YAML Swagger или корневой контекст приложения, указанное в качестве объединенного определения Swagger.

webModuleDoc

Конфигурация для каждого веб-модуля, который предоставляет документацию API для экспорта.

NameTypeDefaultDescription
idstringУникальный ИД конфигурации.
contextRootstringКорневой контекст веб-модуля, для которого предоставляется документация.
enabledbooleantrueБулевское значение, управляющее обработкой документации для данного веб-модуля.
docURLstringURL-адрес документации данного веб-модуля. URL можно задать относительно корневого контекста с помощью символа прямой косой черты (/) или в виде абсолютного адреса, начинающегося символами http или https.
publicbooleantrueБулевское значение, управляющее отображением веб-модуля в общедоступном API.