openapi - OpenAPI (openapi)

OpenAPI 特性的配置。

NameTypeDefaultDescription
customizationstring針對自訂作業,指定 OpenAPI Snippet 的位置。
enablePrivateURLbooleanfalse此布林用來控制是否啟用專用 API 說明文件端點。
publicURLstring/api為公用 API 文件端點指定環境定義根目錄。URL 不需要正斜線 (/)。
validationbooleanfalse此布林用來控制是否驗證 OpenAPI 文件。
disableFileMonitorbooleanfalse此布林用來控制是否監視自訂作業檔案。

webModuleDoc

提供要顯現 API 文件的每一個 Web 模組的配置。

NameTypeDefaultDescription
idstring唯一的配置 ID。
contextRootstring您要為其提供說明文件之 Web 模組的環境定義根目錄。
enabledbooleantrue布林值,用來控制這個 Web 模組說明文件的處理。
publicbooleantrue此布林用來控制是否在公用 API 中顯示 Web 模組。