cxf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From r...@apache.org
Subject [cxf] branch 3.3.x-fixes updated: Added instructions on how to install Swagger UI into Karaf container for Swagger/OpenApi OSGi samples
Date Tue, 17 Sep 2019 02:30:02 GMT
This is an automated email from the ASF dual-hosted git repository.

reta pushed a commit to branch 3.3.x-fixes
in repository https://gitbox.apache.org/repos/asf/cxf.git


The following commit(s) were added to refs/heads/3.3.x-fixes by this push:
     new 7233ba2  Added instructions on how to install Swagger UI into Karaf container for
Swagger/OpenApi OSGi samples
7233ba2 is described below

commit 7233ba20684c3e8f20bf363647c028b2f406f08c
Author: reta <drreta@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


Mime
View raw message