54.2. Swagger ドキュメントへのアクセス

Swagger が Swagger2Feature で有効にされると、サービスエンドポイントの場所の後に /swagger.json または /swagger.yaml が続いて URL が設定される場所で OpenAPI ドキュメントを利用できます。

たとえば、http://host:port/context/services/ でパブリッシュされる JAX-RS エンドポイントの場合 (ここで、context は Web アプリケーションコンテキストで、/services はサーブレット URL)、その Swagger ドキュメンテーションは http://host:port/context/services/swagger.json および http://host:port/context/services/swagger.yaml で利用できます。

Swagger2Feature がアクティブな場合には、CXF Services ページに Swagger ドキュメントへのリンクが追加されます。

上記の例では、http://host:port/context/services/services にアクセスし、Swagger JSON ドキュメントを返す Swagger リンクをたどります。

別のホストの Swagger UI から定義にアクセスするために CORS サポートが必要な場合は、cxf-rt-rs-security-cors から CrossOriginResourceSharingFilter を追加できます。