78.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 来计算名称。

schemes

字符串

要使用的协议方案。可以使用逗号分隔多个值,如 "http,https"。默认值为 "http"。

base.path

字符串

必需 :设置可用 REST 服务的基本路径。该路径是相对的(如不使用 http/https)和 camel-openapi-java 将在运行时计算绝对基本路径,这将是 protocol://host:port/context-path/base.path

api.path

字符串

设置 API 可用的路径(如 /api-docs)。该路径是相对的(如不使用 http/https)和 camel-openapi-java 将在运行时计算绝对基础路径,这将是 protocol://host:port/context-path/api.path,使用相对路径更为容易。如需以上示例,请参阅上述操作。

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。

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.