This is an automated email from the ASF dual-hosted git repository. reta pushed a commit to branch 3.2.x-fixes in repository https://gitbox.apache.org/repos/asf/cxf.git The following commit(s) were added to refs/heads/3.2.x-fixes by this push: new 7fd47bf Added instructions on how to install Swagger UI into Karaf container for Swagger/OpenApi OSGi samples 7fd47bf is described below commit 7fd47bf9316e57ac0a8d66f955440f769a524bb2 Author: reta AuthorDate: Mon Sep 16 22:25:17 2019 -0400 Added instructions on how to install Swagger UI into Karaf container for Swagger/OpenApi OSGi samples --- .../samples/jax_rs/description_openapi_v3_osgi/README.txt | 9 +++++++++ .../samples/jax_rs/description_swagger2_osgi/README.txt | 13 +++++++++++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/distribution/src/main/release/samples/jax_rs/description_openapi_v3_osgi/README.txt b/distribution/src/main/release/samples/jax_rs/description_openapi_v3_osgi/README.txt index 23ae398..1fbab46 100644 --- a/distribution/src/main/release/samples/jax_rs/description_openapi_v3_osgi/README.txt +++ b/distribution/src/main/release/samples/jax_rs/description_openapi_v3_osgi/README.txt @@ -45,6 +45,10 @@ for this demo bundle. feature:install cxf-rs-description-openapi-v3 +Optionally, you could install Swagger UI into Karaf OSGi container: + + install -s mvn:org.webjars/swagger-ui/3.23.0 + Install this demo bundle (using the appropriate bundle version number) install -s mvn:org.apache.cxf.samples/jax_rs_description_openapi_v3_osgi/3.n.m @@ -67,6 +71,11 @@ And its Swagger API documents in either json or yaml are available at http://localhost:8181/cxf/openApiSample/openapi.json http://localhost:8181/cxf/openApiSample/openapi.yaml +If you have installed Swagger UI into the Karaf container, it is available +at: + + http://localhost:8181/cxf/openApiSample/api-docs/?url=/cxf/openApiSample/openapi.json + http://localhost:8181/cxf/openApiSample/api-docs/?url=/cxf/openApiSample/openapi.yaml If you do not have your swagger-ui on your local system, you can download a copy from its download site. diff --git a/distribution/src/main/release/samples/jax_rs/description_swagger2_osgi/README.txt b/distribution/src/main/release/samples/jax_rs/description_swagger2_osgi/README.txt index d0b0ba9..16047a2 100644 --- a/distribution/src/main/release/samples/jax_rs/description_swagger2_osgi/README.txt +++ b/distribution/src/main/release/samples/jax_rs/description_swagger2_osgi/README.txt @@ -45,6 +45,10 @@ for this demo bundle. feature:install cxf-rs-description-swagger2 +Optionally, you could install Swagger UI into Karaf OSGi container: + + install -s mvn:org.webjars/swagger-ui/3.23.0 + Install this demo bundle (using the appropriate bundle version number) install -s mvn:org.apache.cxf.samples/jax_rs_description_swagger2_osgi/3.n.m @@ -67,8 +71,13 @@ And its Swagger API documents in either json or yaml are available at http://localhost:8181/cxf/swaggerSample/swagger.json http://localhost:8181/cxf/swaggerSample/swagger.yaml +If you have installed Swagger UI into the Karaf container, it is available +at: + + http://localhost:8181/cxf/swaggerSample/api-docs/?url=/cxf/swaggerSample/swagger.json + http://localhost:8181/cxf/swaggerSample/api-docs/?url=/cxf/swaggerSample/swagger.yaml -If you do not have your swagger-ui on your local system, you can download +Otherwise, if you do not have your swagger-ui on your local system, you can download a copy from its download site. At the console, type @@ -78,4 +87,4 @@ At the console, type This will extract the content of the swagger-ui zip file. Using your Browser, open the index.html file at swagger-ui-master/dist/. Finally, type in the above swagger -document URL in the input field and click on "Explore" to view the document. +document URL in the input field and click on "Explore" to view the document. \ No newline at end of file