API 探索 (apiDiscovery)
API 探索功能製作您的 REST API 文件的配置。
屬性名稱 | 資料類型 | 預設值 | 說明 |
---|---|---|---|
apiName | string | 聚集 API 的名稱。 | |
maxSubscriptions | int
下限:0 上限:100 |
20 | 指定接聽更新項目的並行 REST API 用戶端數目上限。 |
publicURL | string | /api | %publicURL.desc |
swaggerDefinition | string | %swaggerDefinition.desc |
- webModuleDoc
說明: 提供要顯現 API 文件的每一個 Web 模組的配置。必要: false資料類型: 屬性名稱 資料類型 預設值 說明 contextRoot string 您要為其提供說明文件之 Web 模組的環境定義根目錄。 docURL string 這個 Web 模組的說明文件 URL。可以是以開頭為斜線(/)的環境定義根目錄的相對 URL 或開頭為 http 或 https 的絕對 URL。 enabled boolean true 布林值,用來控制這個 Web 模組說明文件的處理。 id string 唯一的配置 ID。 public boolean true %public.desc