第 335 章 选项
OpenApi 模块可使用以下选项进行配置：要使用 servlet 配置，请使用上文所示的 init-param。在 rest-dsl 中直接配置时，您可以使用适当的方法，如 enableCORS、host、contextPath、dsl。api.xxx 的选项使用 apiProperty dsl 配置。
| 选项 | 类型 | 描述 |
|---|---|---|
| CORS | 布尔值 | 是否启用 CORS。请注意，这只会为 api 浏览器启用 CORS，而不启用对 REST 服务的实际访问权限。默认为 false。 |
| openapi.version | 字符串 | OpenAPI spec 版本。是默认的 3.0。 |
| 主机 | 字符串 | 设置主机名。如果没有配置 camel-openapi-java，它将计算为基于 localhost 的名称。 |
| 方案 | 字符串 | 要使用的协议方案。可以使用逗号分隔多个值，如 "http,https"。默认值为 "http"。 |
| base.path | 字符串 |
必需 ：要设置 REST 服务可用的基本路径。该路径为 relative （例如，不以 http/https 开头），Clal-openapi-java 将在运行时计算绝对基本路径，即 |
| api.path | 字符串 |
要设置 API 可用的路径（如 /api-docs）。该路径是相对的（例如，从 http/https 开始），Carl-openapi-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 | 布尔值 | 是否允许列出 JVM 中具有 REST 服务的所有 CamelContext 名称。启用后，api-doc 的根路径将列出所有上下文。禁用后没有列出上下文 id，api-doc 的根路径列出了当前的 CamelContext。默认为 false。 |
| apiContextIdPattern | 字符串 | 允许过滤在上下文列表中显示 CamelContext 名称的模式。模式使用正则表达式和 * 作为通配符。其与 Intercept 使用的相同的模式匹配 |
