Menu Close

第54章 OpenAPI サポートによる JAX-RS エンドポイントの拡張

概要

CXF OpenApiFeature (org.apache.cxf.jaxrs.openapi.OpenApiFeature) を使用すると、パブリッシュ済みの JAX-RS サービスエンドポイントを単純な設定で拡張することによって OpenAPI ドキュメントを生成できます。

OpenApiFeature は Spring Boot および Karaf 実装の両方でサポートされます。

54.1. OpenApiFeature オプション

OpenApiFeature で以下のオプションを使用できます。

表54.1 OpenApiFeature 操作

名前説明デフォルト

configLocation

OpenAPI 設定の場所

null

contactEmail

連絡先メール+

null

contactName

連絡先名+

null

contactUrl

連絡先リンク+

null

customizer

カスタマイザークラスインスタンス

null

description

説明+

null

filterClass

セキュリティーフィルター++

null

ignoredRoutes

すべてのリソースをスキャンする際に、特定のパスを除外します (scanAllResources を参照)++

null

license

ライセンス+

null

licenseUrl

ライセンス URL+

null

prettyPrint

openapi.json を生成する際に、JSON ドキュメントをプリティープリント出力します++

true

propertiesLocation

プロパティーファイルの場所

/swagger.properties

readAllResources

@Operation なしでもすべての操作を読み取ります++

true

resourceClasses

スキャンする必要があるリソースクラスのリスト++

null

resourcePackages

リソースをスキャンする必要があるパッケージ名のリスト++

null

runAsFilter

機能をフィルターとして実行します。

false

scan

すべての JAX-RS リソースを自動的にスキャンします。

true

scanKnownConfigLocations

既知の OpenAPI 設定の場所 (クラスパスまたはファイルシステム) をスキャンします。

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

true

scannerClass

アプリケーション、リソースパッケージ、リソースクラス、クラスパススキャンなどのスコープ指定を行うために使用される JAX-RS API スキャナークラスの名前。 Resource Scanning セクションを参照してください。

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 が生成されます (「Using Multiple Server Endpoints」を参照してください)。また、scan プロパティーを false に設定することもできます。

false

version

バージョン+

null

+ オプションは OpenAPI クラスで定義されます。

++ オプションが SwaggerConfiguration クラスで定義されます。