第54章 OpenAPI サポートによる JAX-RS エンドポイントの拡張
概要
CXF OpenApiFeature (org.apache.cxf.jaxrs.openapi.OpenApiFeature
) を使用すると、パブリッシュ済みの JAX-RS サービスエンドポイントを単純な設定で拡張することによって OpenAPI ドキュメントを生成できます。
OpenApiFeature は、Spring Boot および Karaf 実装の両方でサポートされます。
54.1. OpenApiFeature オプション
OpenApiFeature では、以下のオプションを使用できます。
名前 | 説明 | デフォルト |
---|---|---|
|
コンテキストルートパス+( | null |
| 連絡先情報 | |
| 説明+ | アプリケーション" |
| セキュリティーフィルター+ | null |
| ホストおよびポート情報+ | null |
|
すべてのリソースをスキャンする際に、特定のパスを除外します ( | null |
| ライセンス+ | "Apache 2.0 ライセンス" |
| ライセンス URL+ | |
|
| false |
| リソースのスキャンが必要なパッケージ名のコンマ区切りの一覧++ | エンドポイントに設定されたサービスクラスの一覧 |
| 機能をフィルターとして実行します。 | false |
| OpenAPI ドキュメントを生成します+ | true |
|
アノテーション付きの JAX-RS リソースを含むすべてのリソースをスキャンします ( | false |
| プロトコルスキーム+ | null |
| OpenAPI UI の設定 | null |
| サービス URL+ | null |
| タイトル+ | "サンプル REST アプリケーション" |
|
OpenAPI が | false |
| バージョン+ | "1.0.0" |
+ オプションは OpenAPI の BeanConfig で定義されます。
++ オプションは OpenAPI の ReaderConfig で定義されます。