openapi - OpenAPI (openapi)

OpenAPI 功能部件的配置。

NameTypeDefaultDescription
customizationstring指定 OpenAPI 片段的位置以进行定制。
enablePrivateURL布尔型false布尔值,用于控制是否启用专用 API 文档端点。
publicURLstring/api为公共 API 文档端点指定上下文根。URL 不需要正斜杠 (/)。
validation布尔型false布尔值,用于控制是否验证 OpenAPI 文档。
disableFileMonitor布尔型false布尔值,用于控制是否监视定制文件。

webModuleDoc

提供要公开 API 文档的每个 Web 模块的配置。

NameTypeDefaultDescription
id字符串唯一配置标识。
contextRootstring要为其提供文档的 Web 模块的上下文根。
enabled布尔型true一个布尔值,用于控制此 Web 模块的文档的处理。
public布尔型true控制是否在公共 API 中显示 Web 模块的布尔值。