API 探索功能製作您的 REST API 文件的配置。
Name | Type | Default | Description |
---|---|---|---|
maxSubscriptions | int Min: 0 Max: 100 | 20 | 指定接聽更新項目的並行 REST API 用戶端數目上限。 |
apiName | string | 聚集 API 的名稱。 | |
publicURL | string | /api | 為公用 API 文件端點指定環境定義根目錄。URL 不需要正斜線 (/)。 |
swaggerDefinition | string | JSON 或 YAML Swagger Snippet 的檔案位置或 URL,或是將當成聚集 Swagger 定義之應用程式的環境定義根目錄。 |
提供要顯現 API 文件的每一個 Web 模組的配置。
Name | Type | Default | Description |
---|---|---|---|
id | string | 唯一的配置 ID。 | |
contextRoot | string | 您要為其提供說明文件之 Web 模組的環境定義根目錄。 | |
enabled | boolean | true | 布林值,用來控制這個 Web 模組說明文件的處理。 |
docURL | string | 這個 Web 模組的說明文件 URL。可以是以開頭為斜線(/)的環境定義根目錄的相對 URL 或開頭為 http 或 https 的絕對 URL。 | |
public | boolean | true | 此布林用來控制是否在公用 API 中顯示 Web 模組。 |