apiDiscovery - API 探索 (apiDiscovery)

API 探索功能製作您的 REST API 文件的配置。

NameTypeDefaultDescription
maxSubscriptionsint
Min: 0

Max: 100
20指定接聽更新項目的並行 REST API 用戶端數目上限。
apiNamestring聚集 API 的名稱。
publicURLstring/api為公用 API 文件端點指定環境定義根目錄。URL 不需要正斜線 (/)。
swaggerDefinitionstringJSON 或 YAML Swagger Snippet 的檔案位置或 URL,或是將當成聚集 Swagger 定義之應用程式的環境定義根目錄。

webModuleDoc

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

NameTypeDefaultDescription
idstring唯一的配置 ID。
contextRootstring您要為其提供說明文件之 Web 模組的環境定義根目錄。
enabledbooleantrue布林值,用來控制這個 Web 模組說明文件的處理。
docURLstring這個 Web 模組的說明文件 URL。可以是以開頭為斜線(/)的環境定義根目錄的相對 URL 或開頭為 http 或 https 的絕對 URL。
publicbooleantrue此布林用來控制是否在公用 API 中顯示 Web 模組。