Конфигурация функции обнаружения API для предоставления документации по API REST.
Name | Type | Default | Description |
---|---|---|---|
maxSubscriptions | int Min: 0 Max: 100 | 20 | Задает максимальное число клиентов API REST, которые одновременно могут получать обновления. |
apiName | string | Имя объединенного API. | |
publicURL | string | /api | Задает корневой контекст для конечных точек общедоступной документации по API. В URL не требуется прямая косая черта (/). |
swaggerDefinition | string | Расположение файла, URL для JSON, фрагмент кода YAML Swagger или корневой контекст приложения, указанное в качестве объединенного определения Swagger. |
Конфигурация для каждого веб-модуля, который предоставляет документацию API для экспорта.
Name | Type | Default | Description |
---|---|---|---|
id | string | Уникальный ИД конфигурации. | |
contextRoot | string | Корневой контекст веб-модуля, для которого предоставляется документация. | |
enabled | boolean | true | Булевское значение, управляющее обработкой документации для данного веб-модуля. |
docURL | string | URL-адрес документации данного веб-модуля. URL можно задать относительно корневого контекста с помощью символа прямой косой черты (/) или в виде абсолютного адреса, начинающегося символами http или https. | |
public | boolean | true | Булевское значение, управляющее отображением веб-модуля в общедоступном API. |