97.2. 选项
可使用以下选项配置 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 服务的基本路径。该路径相对(例如没有以 http/https 开始),camel-openapi-java 将在运行时计算绝对路径,该路径将是 |
api.path | 字符串 |
设置 API 可用的路径(如 /api-docs)。该路径相对(例如,没有以 http/https 开头),而 camel-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。 |