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