第 54 章使用 OpenAPI 支持扩展 JAX-RS 端点

摘要

CXF OpenApiFeature (org.apache.cxf.jaxrs.openapi.OpenApiFeature)允许您通过通过简单配置来扩展公布的 JAX-RS 服务端点来生成 OpenAPI 文档。

Spring Boot 和 Karaf 实现中均支持 OpenApiFeature。

54.1. OpenApiFeature 选项

您可以在 OpenApiFeature 中使用以下选项：

表 54.1. OpenApiFeature 操作
名称	描述	默认
`basePath`	上下文根路径+（请参阅 `usePathBasedConfig` 选项）	null
`contact`	您的联系信息+	"users@cxf.apache.org"
`description`	description+	"应用程序"
`filterClass`	安全过滤器+	null
`主机`	主机和端口信息+	null
`ignoreRoutes`	扫描所有资源时排除特定路径（请参阅 `scanAllResources` 选项）++	null
`license`	许可证+	"Apache 2.0 许可证"
`licenceUrl`	许可证 URL+	`http://www.apache.org/licenses/LICENSE-2.0.html`
`prettyPrint`	生成 `openapi.json` 时，指定为 JSON 文档+	false
`resourcePackage`	以逗号分隔的软件包名称列表，其中资源必须扫描+	在端点中配置的服务类列表
`runAsFilter`	作为过滤器运行该功能	false
`scan`	生成 OpenAPI 文档+	true
`scanAllResources`	扫描包括非注解 JAX-RS 资源的所有资源（请参阅 `ignoreRoutes` 选项）++	false
`schemes`	协议方案+	null
`openapiUiConfig`	OpenAPI UI 配置	null
`termsOfServiceUrl`	服务 URL+ 条款.	null
`title`	标题+	"sample REST Application"
`usePathBasedConfig`	防止 OpenAPI 缓存 `basePath` 选项的值。	false
`version`	版本+	"1.0.0"

+ 选项在 OpenAPIs 的 BeanConfig 中定义

++ 选项在 OpenAPI 的 ReaderConfig 中定义

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

© 2024 Red Hat, Inc.