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 片段的文件位置或 URL 或者将视为聚集 Swagger 定义的应用程序的上下文根。 |
提供要公开 API 文档的每个 Web 模块的配置。
Name | Type | Default | Description |
---|---|---|---|
id | 字符串 | 唯一配置标识。 | |
contextRoot | string | 要为其提供文档的 Web 模块的上下文根。 | |
enabled | 布尔型 | true | 一个布尔值,用于控制此 Web 模块的文档的处理。 |
docURL | string | 此 Web 模块的文档的 URL。该 URL 可以是以开头为正斜杠 (/) 的上下文根的相对 URL 或开头为 http 或 https 的绝对 URL。 | |
public | 布尔型 | true | 控制是否在公共 API 中显示 Web 模块的布尔值。 |