You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by re...@apache.org on 2019/09/17 02:25:32 UTC
[cxf] branch master updated: Added instructions on how to install
Swagger UI into Karaf container for Swagger/OpenApi OSGi samples
This is an automated email from the ASF dual-hosted git repository.
reta pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cxf.git
The following commit(s) were added to refs/heads/master by this push:
new 0ed0986 Added instructions on how to install Swagger UI into Karaf container for Swagger/OpenApi OSGi samples
0ed0986 is described below
commit 0ed0986483b16b858ce83416ba0f685c058571f8
Author: reta <dr...@gmail.com>
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 c0cf0ef..217c8bd 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
@@ -46,6 +46,10 @@ for this demo bundle.
feature:install cxf-rs-description-openapi-v3
feature:install aries-blueprint
+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
@@ -68,6 +72,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 e43c86a..61a04fb 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
@@ -46,6 +46,10 @@ for this demo bundle.
feature:install cxf-rs-description-swagger2
feature:install aries-blueprint
+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
@@ -68,8 +72,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
@@ -79,4 +88,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