第 54 章 使用 OpenAPI 支持扩展 JAX-RS 端点
摘要
CXF OpenApiFeature (org.apache.cxf.jaxrs.openapi.OpenApiFeature)允许您通过使用简单的配置扩展发布的 JAX-RS 服务端点来生成 OpenAPI 文档。
Spring Boot 和 Karaf 实现都支持 OpenApiFeature。
54.1. OpenApiFeature 选项
您可以使用 OpenApiFeature 中的以下选项。
| Name | 描述 | default |
|---|---|---|
|
| OpenAPI 配置位置 | null |
|
| 联系电子邮件+ | null |
|
| 联系名称+ | null |
|
| 联系链接+ | null |
|
| customr 类实例 | null |
|
| description+ | null |
|
| 安全过滤器++ | null |
|
|
扫描所有资源时排除特定路径（请参阅 | null |
|
| 许可证+ | null |
|
| 许可证 URL+ | null |
|
| 在生成 openapi.json 时，pretty-print JSON 文档++ | true |
|
| 属性文件位置 |
|
|
| 也读取没有 @Operation++ 的所有操作 | true |
|
| 必须扫描++ 的资源类列表 | null |
|
| 必须扫描资源的软件包名称列表++ | null |
|
| 将该功能作为过滤器运行 | false |
|
| 自动扫描所有 JAX-RS 资源 | true |
|
| 扫描已知的 OpenAPI 配置位置(classpath 或文件系统)，它们是： openapi-configuration.yaml openapi-configuration.json openapi.yaml openapi.json | true |
|
| JAX-RS API 扫描程序类的名称，用于限制应用、资源软件包、资源类和类路径扫描，请参阅 资源扫描 部分 | null |
|
| 安全定义列表+ | null |
|
| 打开/关闭 SwaggerUI 支持 | null (== true) |
|
| Swagger UI 配置 | null |
|
| 用于固定 SwaggerUI 的 Maven 工件 | null |
|
| SwaggerUI 的版本 | null |
|
| 服务 URL 的条款+ | null |
|
| 标题+ | null |
|
| 如果设置，则会为每个 OpenApiContext 实例生成唯一的上下文 Id （请参阅 使用多服务器端点）。另外，您可能想将扫描属性设置为 false。 | false |
|
| version+ | null |
+ 选项在 OpenAPI 类中定义
++ 选项在 SwaggerConfiguration 类中定义
