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

configLocation

OpenAPI 配置位置

null

contactEmail

联系电子邮件+

null

contactName

联系名称+

null

contactUrl

联系链接+

null

customr

customr 类实例

null

description

description+

null

filterClass

安全过滤器++

null

ignoredRoutes

扫描所有资源时排除特定路径（请参阅 scanAllResources）++

null

许可证

许可证+

null

licenseUrl

许可证 URL+

null

prettyPrint

在生成 openapi.json 时，pretty-print JSON 文档++

true

propertiesLocation

属性文件位置

/swagger.properties

readAllResources

也读取没有 @Operation++ 的所有操作

true

resourceClasses

必须扫描++ 的资源类列表

null

resourcePackages

必须扫描资源的软件包名称列表++

null

runAsFilter

将该功能作为过滤器运行

false

扫描

自动扫描所有 JAX-RS 资源

true

scanKnownConfigLocations

扫描已知的 OpenAPI 配置位置(classpath 或文件系统)，它们是：

openapi-configuration.yaml
openapi-configuration.json
openapi.yaml
openapi.json

true

scannerClass

JAX-RS API 扫描程序类的名称，用于限制应用、资源软件包、资源类和类路径扫描，请参阅 资源扫描 部分

null

securityDefinitions

安全定义列表+

null

supportSwaggerUi

打开/关闭 SwaggerUI 支持

null (== true)

swaggerUiConfig

Swagger UI 配置

null

swaggerUiMavenGroupAndArtifact

用于固定 SwaggerUI 的 Maven 工件

null

swaggerUiVersion

SwaggerUI 的版本

null

termsOfServiceUrl

服务 URL 的条款+

null

title

标题+

null

useContextBasedConfig

如果设置，则会为每个 OpenApiContext 实例生成唯一的上下文 Id （请参阅 使用多服务器端点）。另外，您可能想将扫描属性设置为 false。

false

version

version+

null