OpenAPI 功能部件的配置。
Name | Type | Default | Description |
---|---|---|---|
customization | string | 指定 OpenAPI 片段的位置以进行定制。 | |
enablePrivateURL | 布尔型 | false | 布尔值,用于控制是否启用专用 API 文档端点。 |
publicURL | string | /api | 为公共 API 文档端点指定上下文根。URL 不需要正斜杠 (/)。 |
validation | 布尔型 | false | 布尔值,用于控制是否验证 OpenAPI 文档。 |
disableFileMonitor | 布尔型 | false | 布尔值,用于控制是否监视定制文件。 |
提供要公开 API 文档的每个 Web 模块的配置。
Name | Type | Default | Description |
---|---|---|---|
id | 字符串 | 唯一配置标识。 | |
contextRoot | string | 要为其提供文档的 Web 模块的上下文根。 | |
enabled | 布尔型 | true | 一个布尔值,用于控制此 Web 模块的文档的处理。 |
public | 布尔型 | true | 控制是否在公共 API 中显示 Web 模块的布尔值。 |