341.2. 选项
可以使用以下选项配置 swagger 模块:要使用您如上所示的 init-param 使用 servlet 来配置。在 rest-dsl 中直接配置时,您可以使用适当的方法,如 enableCORS
,host,contextPath
, dsl。带有 api.xxx
的选项使用 apiProperty
dsl 进行配置。
选项 | 类型 | 描述 |
---|---|---|
CORS | 布尔值 | 是否启用 CORS。请注意,这只为 api 浏览器启用 CORS,而不启用对 REST 服务的实际访问权限。默认为 false。 |
swagger.version | 字符串 | Swagger spec 版本。默认 2.0。 |
主机 | 字符串 | 设置主机名:如果没有配置 camel-swagger-java,则会计算名称为 localhost。 |
模式 | 字符串 | 要使用的协议方案。可以使用逗号分隔多个值,如 "http,https"。默认值为 "http"。这个选项在 Camel 2.17 以后 被弃用,因为它应该被命名为 schemes。 |
schemes | 字符串 | Camel 2.17: 要使用的协议方案。可以使用逗号分隔多个值,如 "http,https"。默认值为 "http"。 |
base.path | 字符串 |
必需 :设置 REST 服务可用的基本路径。该路径是 relative (例如不以 http/https 开头),camel-swagger-java 将在运行时计算绝对路径,其为 |
api.path | 字符串 |
要设置 API 可用的路径(如 /api-docs)。该路径是 relative (例如,没有以 http/https 开头的),camel-swagger-java 将在运行时计算绝对路径,它将是 |
api.version | 字符串 | api 的版本。默认为 0.0.0。 |
api.title | 字符串 | 应用程序的标题。 |
api.description | 字符串 | 应用程序的简短描述。 |
api.termsOfService | 字符串 | API 条款的 URL。 |
api.contact.name | 字符串 | 要联系的人员或机构的名称 |
api.contact.email | 字符串 | 用于与 API 相关的相应电子邮件。 |
api.contact.url | 字符串 | 网站的 URL 获取更多信息。 |
api.license.name | 字符串 | 用于 API 的许可证名称。 |
api.license.url | 字符串 | 用于 API 的许可证的 URL。 |
apiContextIdListing | 布尔值 | 是否允许列出具有 REST 服务的 JVM 中的所有 CamelContext 名称。启用后,api-doc 的根路径将列出所有上下文。当禁用时,没有列出上下文 id,api-doc 的根路径会列出当前的 CamelContext。默认为 false。 |
apiContextIdPattern | 字符串 | 允许过滤在上下文列表中显示哪个 CamelContext 名称的模式。该模式使用正则表达式,作为通配符。其与 Intercept 使用的模式匹配 |