openapi - OpenAPI (openapi)

Конфигурация для функции OpenAPI.

NameTypeDefaultDescription
customizationstringЗадает расположение фрагмента кода OpenAPI для настройки.
enablePrivateURLbooleanfalseБулевское значение, которое указывает, включены ли конечные точки частной документации по API.
publicURLstring/apiЗадает корневой контекст для конечных точек общедоступной документации по API. В URL не требуется прямая косая черта (/).
validationbooleanfalseБулевское значение, управляющее проверкой документов OpenAPI.
disableFileMonitorbooleanfalseБулевское значение, управляющее мониторингом файлов настройки.

webModuleDoc

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

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