Menu Close

54.4. OpenAPI ドキュメントへのアクセス

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

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

OpenApiFeature がアクティブである場合、CXF Services ページは OpenAPI ドキュメントにリンクされます。

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

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