第54章 OpenAPI サポートによる JAX-RS エンドポイントの拡張
概要
CXF OpenApiFeature (org.apache.cxf.jaxrs.openapi.OpenApiFeature) を使用すると、パブリッシュ済みの JAX-RS サービスエンドポイントを単純な設定で拡張することによって OpenAPI ドキュメントを生成できます。
OpenApiFeature は、Spring Boot および Karaf 実装の両方でサポートされます。
54.1. OpenApiFeature オプション
OpenApiFeature では、以下のオプションを使用できます。
| 名前 | 説明 | デフォルト |
|---|---|---|
|
| OpenAPI 設定の場所 | null |
|
| 連絡先メール+ | null |
|
| 連絡先名+ | null |
|
| 連絡先リンク+ | null |
|
| カスタマイザークラスインスタンス | null |
|
| 説明+ | null |
|
| セキュリティーフィルター++ | null |
|
|
すべてのリソースをスキャンする際に、特定のパスを除外します ( | null |
|
| ライセンス+ | null |
|
| ライセンス URL+ | null |
|
| openapi.json を生成する際に、JSON ドキュメント++ をプリティープリントで出力します。 | true |
|
| プロパティーファイルの場所 |
|
|
| @Operation++ なしですべての操作も読み取ります。 | true |
|
| スキャンする必要があるリソースクラスのリスト | null |
|
| リソースのスキャンが必要なパッケージ名のリスト++ | null |
|
| 機能をフィルターとして実行します。 | false |
|
| すべての JAX-RS リソースを自動的にスキャンします。 | true |
|
| 既知の OpenAPI 設定の場所 (クラスパスまたはファイルシステム) をスキャンします。 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 インスタンスに対して一意の Context Id が生成されます (複数のサーバーエンドポイントの使用 を参照)。また、scan プロパティーを false に設定することもできます。 | false |
|
| バージョン+ | null |
+ オプションは OpenAPI クラスで定義されます。
++ オプションは SwaggerConfiguration クラスで定義されます。
