Конфигурация для функции OpenAPI.
Name | Type | Default | Description |
---|---|---|---|
customization | string | Задает расположение фрагмента кода OpenAPI для настройки. | |
enablePrivateURL | boolean | false | Булевское значение, которое указывает, включены ли конечные точки частной документации по API. |
publicURL | string | /api | Задает корневой контекст для конечных точек общедоступной документации по API. В URL не требуется прямая косая черта (/). |
validation | boolean | false | Булевское значение, управляющее проверкой документов OpenAPI. |
disableFileMonitor | boolean | false | Булевское значение, управляющее мониторингом файлов настройки. |
Конфигурация для каждого веб-модуля, который предоставляет документацию API для экспорта.
Name | Type | Default | Description |
---|---|---|---|
id | string | Уникальный ИД конфигурации. | |
contextRoot | string | Корневой контекст веб-модуля, для которого предоставляется документация. | |
enabled | boolean | true | Булевское значение, управляющее обработкой документации для данного веб-модуля. |
public | boolean | true | Булевское значение, управляющее отображением веб-модуля в общедоступном API. |