9.4. MicroProfile OpenAPI 参考

mp.openapi.extensions.enabled

true

启用或禁用注册 OpenAPI 端点。

当设置为 false 时，将禁用 OpenAPI 文档的生成。您可以使用 config 子系统或在配置文件中为各个应用设置全局值，如 /META-INF/microprofile-config.properties。

您可以将此属性参数化为在不同环境中有选择地启用或禁用 microprofile-openapi-smallrye，如生产或开发。

您可以使用此属性来控制与给定虚拟主机关联的应用应生成 MicroProfile OpenAPI 模型。

mp.openapi.extensions.path

/openapi

您可以使用此属性为与虚拟主机关联的多个应用程序生成 OpenAPI 文档。

在与同一虚拟主机关联的每个应用程序上设置一个 distinct mp.openapi.extensions.path。

mp.openapi.extensions.servers.relative

true

指明自动生成的服务器记录是绝对还是相对于 OpenAPI 端点的位置。

需要服务器记录才能确保在存在非根上下文路径的情况下，OpenAPI 文档的用户可以相对于 OpenAPI 端点的主机构建到 REST 服务的有效 URL。

值 true 表示服务器记录相对于 OpenAPI 端点的位置。生成的记录包含部署的上下文路径。

如果设置为 false，JBoss EAP XP 将生成服务器记录，包括可以访问部署的所有协议、主机和端口。