OpenAPI 特性的配置。
Name | Type | Default | Description |
---|---|---|---|
customization | string | 針對自訂作業,指定 OpenAPI Snippet 的位置。 | |
enablePrivateURL | boolean | false | 此布林用來控制是否啟用專用 API 說明文件端點。 |
publicURL | string | /api | 為公用 API 文件端點指定環境定義根目錄。URL 不需要正斜線 (/)。 |
validation | boolean | false | 此布林用來控制是否驗證 OpenAPI 文件。 |
disableFileMonitor | boolean | false | 此布林用來控制是否監視自訂作業檔案。 |
提供要顯現 API 文件的每一個 Web 模組的配置。
Name | Type | Default | Description |
---|---|---|---|
id | string | 唯一的配置 ID。 | |
contextRoot | string | 您要為其提供說明文件之 Web 模組的環境定義根目錄。 | |
enabled | boolean | true | 布林值,用來控制這個 Web 模組說明文件的處理。 |
public | boolean | true | 此布林用來控制是否在公用 API 中顯示 Web 模組。 |