cxf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r995244 - in /websites/production/cxf/content: cache/docs.pageCache docs/springboot.html docs/swaggerfeature-swagger2feature.html
Date Tue, 16 Aug 2016 16:47:35 GMT
Author: buildbot
Date: Tue Aug 16 16:47:35 2016
New Revision: 995244

Log:
Production update by buildbot for cxf

Modified:
    websites/production/cxf/content/cache/docs.pageCache
    websites/production/cxf/content/docs/springboot.html
    websites/production/cxf/content/docs/swaggerfeature-swagger2feature.html

Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary files - no diff available.

Modified: websites/production/cxf/content/docs/springboot.html
==============================================================================
--- websites/production/cxf/content/docs/springboot.html (original)
+++ websites/production/cxf/content/docs/springboot.html Tue Aug 16 16:47:35 2016
@@ -119,11 +119,11 @@ Apache CXF -- SpringBoot
            <!-- Content -->
            <div class="wiki-content">
 <div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1469886419802 {padding: 0px;}
-div.rbtoc1469886419802 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1469886419802 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1471366020826 {padding: 0px;}
+div.rbtoc1471366020826 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1471366020826 li {margin-left: 0px;padding-left: 0px;}
 
-/*]]>*/</style></p><div class="toc-macro rbtoc1469886419802">
+/*]]>*/</style></p><div class="toc-macro rbtoc1471366020826">
 <ul class="toc-indentation"><li><a shape="rect" href="#SpringBoot-SpringBootCXFJAX-WSStarter">Spring
Boot CXF JAX-WS Starter</a>
 <ul class="toc-indentation"><li><a shape="rect" href="#SpringBoot-Features">Features</a></li><li><a
shape="rect" href="#SpringBoot-Setup">Setup</a></li><li><a shape="rect"
href="#SpringBoot-AdditionalConfiguration">Additional Configuration</a></li><li><a
shape="rect" href="#SpringBoot-APIDocumentation">API Documentation</a></li><li><a
shape="rect" href="#SpringBoot-ServiceRegistryPublication">Service Registry Publication</a></li><li><a
shape="rect" href="#SpringBoot-Examples">Examples</a></li></ul>
 </li><li><a shape="rect" href="#SpringBoot-SpringBootCXFJAX-RSStarter">Spring
Boot CXF&#160;JAX-RS Starter</a>
@@ -139,7 +139,7 @@ div.rbtoc1469886419802 li {margin-left:
     &lt;artifactId&gt;cxf-spring-boot-starter-jaxws&lt;/artifactId&gt;
     &lt;version&gt;3.1.7&lt;/version&gt;
 &lt;/dependency&gt;</pre>
-</div></div><h2 id="SpringBoot-AdditionalConfiguration">Additional Configuration</h2><p>Use
"<strong>cxf.path</strong>" property to customize a CXFServlet URL pattern</p><h2
id="SpringBoot-APIDocumentation">API Documentation</h2><p>JAX-WS endpoints
support WSDL.</p><h2 id="SpringBoot-ServiceRegistryPublication">Service Registry
Publication</h2><p>Publication of JAX-WS endpoints into well-known service registries
such as Netflix Eureka Registry can be achieved similarly to the way JAX-RS endpoints are
registered and is shown in a <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/spring_boot_scan/application"
rel="nofollow">JAX-RS Spring Boot Scan</a> demo.</p><h2 id="SpringBoot-Examples">Examples</h2><p>Consider
the following Configuration instance:</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-WS
Configuration</
 b></div><div class="codeContent panelContent pdl">
+</div></div><h2 id="SpringBoot-AdditionalConfiguration">Additional Configuration</h2><p>Use
"<strong>cxf.path</strong>" property to customize a CXFServlet URL pattern</p><p>Use
"<strong>cxf.servlet.init</strong>" map property to customize CXFServlet properties
such as "services-list-path" (available by default at&#160; "/services"), etc.</p><h2
id="SpringBoot-APIDocumentation">API Documentation</h2><p>JAX-WS endpoints
support WSDL.</p><h2 id="SpringBoot-ServiceRegistryPublication">Service Registry
Publication</h2><p>Publication of JAX-WS endpoints into well-known service registries
such as Netflix Eureka Registry can be achieved similarly to the way JAX-RS endpoints are
registered and is shown in a <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/spring_boot_scan/application"
rel="nofollow">JAX-RS Spring Boot Scan</a> demo.</p><h2 id="SpringBoot-Examples">Examples</h2><p>Consider
the following Configur
 ation instance:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-WS Configuration</b></div><div
class="codeContent panelContent pdl">
 <pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">package
sample.ws;
 
 import javax.xml.ws.Endpoint;
@@ -169,7 +169,7 @@ public class WebServiceConfig {
     &lt;artifactId&gt;cxf-spring-boot-starter-jaxrs&lt;/artifactId&gt;
     &lt;version&gt;3.1.7&lt;/version&gt;
 &lt;/dependency&gt;</pre>
-</div></div><h2 id="SpringBoot-AdditionalConfiguration.1">Additional Configuration</h2><p>Use
"<strong>cxf.path</strong>" property to customize a CXFServlet URL pattern.</p><p>JAX-RS
root resources and providers annotated with JAX-RS @Path and @Provider and native CXF Providers
annotated with CXF <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/cxf-3.1.6/core/src/main/java/org/apache/cxf/annotations/Provider.java"
rel="nofollow">@Provider</a> can be auto-discovered.</p><p>Use "<strong>cxf.jaxrs.component-scan</strong>"
property to create a JAX-RS endpoint from the auto-discovered&#160;JAX-RS root resources
and providers which are marked as Spring Components (annotated with Spring @Component or created
and returned from @Bean methods).</p><p>Use "<strong>cxf.jaxrs.classes-scan</strong>"
property to create a JAX-RS endpoint from the auto-discovered&#160;JAX-RS root resources
and provider classes. Such classes do not have to be annotated with Spring @Compo
 nent. This property needs to be accompanied by a "<strong>cxf.jaxrs.classes-scan-packages</strong>"
property which sets a comma-separated list of the packages to scan.</p><p>Note
that while "<strong>cxf.jaxrs.component-scan</strong>" and "<strong>cxf.jaxrs.classes-scan</strong>"
are mutually exclusive, "<strong>cxf.jaxrs.component-scan</strong>" can be used
alongside the "<strong>cxf.jaxrs.classes-scan-packages</strong>" property to enable
the auto-discovery of the JAX-RS resources and providers which may or may not be marked as
Spring Components.</p><h2 id="SpringBoot-APIDocumentation.1">API Documentation</h2><h3
id="SpringBoot-Swagger">Swagger</h3><p>See CXF <a shape="rect" href="swaggerfeature-swagger2feature.html#SwaggerFeature/Swagger2Feature-EnablinginSpringBoot"
rel="nofollow">Swagger2Feature documentation</a> on how to enable Swagger2Feature
in SpringBoot and how to auto-activate Swagger UI.</p><h3 id="SpringBoot-WADL">WADL</h3><p>CXF
automatically loads a WADL provider if a
  <strong>cxf-rt-rs-service-description</strong> module is available on the runtime
classpath.</p><h2 id="SpringBoot-ServiceRegistryPublication.1">Service Registry
Publication</h2><p>Publication of JAX-RS endpoints into well-known service registries
such as Netflix Eureka Registry is shown in a <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/spring_boot_scan/application"
rel="nofollow">JAX-RS Spring Boot Scan</a> demo.</p><h2 id="SpringBoot-Examples.1">Examples</h2><h3
id="SpringBoot-ManualConfiguration">Manual Configuration</h3><p>Consider the
following Configuration instance:</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-RS
Configuration</b></div><div class="codeContent panelContent pdl">
+</div></div><h2 id="SpringBoot-AdditionalConfiguration.1">Additional Configuration</h2><p>Use
"<strong>cxf.path</strong>" property to customize a CXFServlet URL pattern.</p><p>Use
"<strong>cxf.servlet.init</strong>" map property to customize CXFServlet properties
such as "services-list-path" (available by default at&#160; "/services"), etc.</p><p>Use
"<strong>cxf.jaxrs.server.path</strong>" property to customize a JAX-RS server
endpoint address (default is "/").</p><p>JAX-RS root resources and providers annotated
with JAX-RS @Path and @Provider and native CXF Providers annotated with CXF <a shape="rect"
class="external-link" href="https://github.com/apache/cxf/blob/cxf-3.1.6/core/src/main/java/org/apache/cxf/annotations/Provider.java"
rel="nofollow">@Provider</a> can be auto-discovered.</p><p>Use "<strong>cxf.jaxrs.component-scan</strong>"
property to create a JAX-RS endpoint from the auto-discovered&#160;JAX-RS root resources
and providers which are marked as Spring Components (ann
 otated with Spring @Component or created and returned from @Bean methods).</p><p>Use
"<strong>cxf.jaxrs.classes-scan</strong>" property to create a JAX-RS endpoint
from the auto-discovered&#160;JAX-RS root resources and provider classes. Such classes
do not have to be annotated with Spring @Component. This property needs to be accompanied
by a "<strong>cxf.jaxrs.classes-scan-packages</strong>" property which sets a
comma-separated list of the packages to scan.</p><p>Note that while "<strong>cxf.jaxrs.component-scan</strong>"
and "<strong>cxf.jaxrs.classes-scan</strong>" are mutually exclusive, "<strong>cxf.jaxrs.component-scan</strong>"
can be used alongside the "<strong>cxf.jaxrs.classes-scan-packages</strong>" property
to enable the auto-discovery of the JAX-RS resources and providers which may or may not be
marked as Spring Components.</p><h2 id="SpringBoot-APIDocumentation.1">API Documentation</h2><h3
id="SpringBoot-Swagger">Swagger</h3><p>See CXF <a shape="rect" href="swaggerfe
 ature-swagger2feature.html#SwaggerFeature/Swagger2Feature-EnablinginSpringBoot" rel="nofollow">Swagger2Feature
documentation</a> on how to enable Swagger2Feature in SpringBoot and how to auto-activate
Swagger UI.</p><h3 id="SpringBoot-WADL">WADL</h3><p>CXF automatically
loads a WADL provider if a <strong>cxf-rt-rs-service-description</strong> module
is available on the runtime classpath.</p><h2 id="SpringBoot-ServiceRegistryPublication.1">Service
Registry Publication</h2><p>Publication of JAX-RS endpoints into well-known service
registries such as Netflix Eureka Registry is shown in a <a shape="rect" class="external-link"
href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/spring_boot_scan/application"
rel="nofollow">JAX-RS Spring Boot Scan</a> demo.</p><h2 id="SpringBoot-Examples.1">Examples</h2><h3
id="SpringBoot-ManualConfiguration">Manual Configuration</h3><p>Consider the
following Configuration instance:</p><div class="code panel pdl" st
 yle="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width:
1px;"><b>JAX-RS Configuration</b></div><div class="codeContent panelContent
pdl">
 <pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">package
sample.rs.service;
 import java.util.Arrays;
 

Modified: websites/production/cxf/content/docs/swaggerfeature-swagger2feature.html
==============================================================================
--- websites/production/cxf/content/docs/swaggerfeature-swagger2feature.html (original)
+++ websites/production/cxf/content/docs/swaggerfeature-swagger2feature.html Tue Aug 16 16:47:35
2016
@@ -118,11 +118,11 @@ Apache CXF -- SwaggerFeature / Swagger2F
            <!-- Content -->
            <div class="wiki-content">
 <div id="ConfluenceContent"><h1 id="SwaggerFeature/Swagger2Feature-SwaggerFeature/Swagger2Feature">SwaggerFeature
/ Swagger2Feature</h1><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1469821617901 {padding: 0px;}
-div.rbtoc1469821617901 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1469821617901 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1471366019698 {padding: 0px;}
+div.rbtoc1471366019698 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1471366019698 li {margin-left: 0px;padding-left: 0px;}
 
-/*]]>*/</style></p><div class="toc-macro rbtoc1469821617901">
+/*]]>*/</style></p><div class="toc-macro rbtoc1471366019698">
 <ul class="toc-indentation"><li><a shape="rect" href="#SwaggerFeature/Swagger2Feature-SwaggerFeature/Swagger2Feature">SwaggerFeature
/ Swagger2Feature</a></li><li><a shape="rect" href="#SwaggerFeature/Swagger2Feature-Setup">Setup</a></li><li><a
shape="rect" href="#SwaggerFeature/Swagger2Feature-Properties">Properties</a></li><li><a
shape="rect" href="#SwaggerFeature/Swagger2Feature-ConfiguringProgramatically">Configuring
Programatically</a></li><li><a shape="rect" href="#SwaggerFeature/Swagger2Feature-ConfiguringinSpring">Configuring
in Spring</a></li><li><a shape="rect" href="#SwaggerFeature/Swagger2Feature-ConfiguringinBlueprint">Configuring
in Blueprint</a></li><li><a shape="rect" href="#SwaggerFeature/Swagger2Feature-ConfiguringinCXFNonSpringJaxrsServlet">Configuring
in CXFNonSpringJaxrsServlet</a></li><li><a shape="rect" href="#SwaggerFeature/Swagger2Feature-EnablinginSpringBoot">Enabling
in Spring Boot</a></li><li><a shape="rect" href="#SwaggerFeature/Swagger2Feature-Accessing
 SwaggerDocuments">Accessing Swagger Documents</a></li><li><a shape="rect"
href="#SwaggerFeature/Swagger2Feature-EnablingSwaggerUI">Enabling Swagger UI</a>
 <ul class="toc-indentation"><li><a shape="rect" href="#SwaggerFeature/Swagger2Feature-AutomaticUIActivation">Automatic
UI Activation</a></li><li><a shape="rect" href="#SwaggerFeature/Swagger2Feature-UnpackingSwaggerUIresources">Unpacking
Swagger UI resources</a></li></ul>
 </li><li><a shape="rect" href="#SwaggerFeature/Swagger2Feature-Samples">Samples</a></li></ul>
@@ -260,7 +260,7 @@ import org.apache.cxf.jaxrs.swagger.Swag
 &lt;/dependency&gt;
 
 </pre>
-</div></div><h2 id="SwaggerFeature/Swagger2Feature-AutomaticUIActivation">Automatic
UI Activation</h2><p>This feature is available starting from CXF 3.1.7: Adding
a Swagger UI Maven dependency is all what is needed to start accessing Swagger documents with
the help of Swagger UI.</p><p>For example, lets assume a JAX-RS endpoint is published
at '<span>http://host:port/context/services/</span>'.</p><p>Open the
browser and go to '<span>http://host:port/context/services/</span>api-docs?/url=/swagger.json'
which will return a Swagger UI page.</p><p>CXF Services page will also link to
Swagger UI. Go to&#160;'<span>http://host:port/context/services/</span>services'
and follow a Swagger link which will return a Swagger UI page.</p><p>See <a
shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/description_swagger2"
rel="nofollow">samples/jax_rs/description_swagger2</a>,&#160;<a shape="rect"
class="external-link" href=
 "https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/spring_boot"
rel="nofollow">samples/jax_rs/spring_boot</a> and <a shape="rect" class="external-link"
href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/spring_boot_scan"
rel="nofollow">samples/jax_rs/spring_boot_scan</a>&#160;</p><h2 id="SwaggerFeature/Swagger2Feature-UnpackingSwaggerUIresources">Unpacking
Swagger UI resources</h2><p>Up until CXF 3.1.7 unpacking Swagger UI resources
into the local folder has been the only option. It is demoed in all CXF Swagger demos but
samples/jax_rs/description_swagger2 which</p><p>shows the automatic UI activation.
In CXF 3.1.7: set Swagger2Feature 'supportSwaggerUi' property to 'false' to disable to automatic
UI activation described in the previous section</p><h1 id="SwaggerFeature/Swagger2Feature-Samples">Samples</h1><p><span>CXF's
distribution contains the following samples.</span></p><ul><li><a
shape="rect" class=
 "external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/description_swagger"
rel="nofollow">samples/jax_rs/description_swagger</a>: Swagger 1.2 sample using SwaggerFeature
programatically</li><li><a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/description_swagger2"
rel="nofollow">samples/jax_rs/description_swagger2</a>:&#160;Swagger 2.0 standalone
sample using Swagger2Feature programatically</li><li><a shape="rect" class="external-link"
href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/description_swagger2_spring"
rel="nofollow">samples/jax_rs/description_swagger2_spring</a>:&#160;Swagger 2.0
standalone sample using Swagger2Feature using Spring</li><li><a shape="rect"
class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/description_swagger2_web"

 rel="nofollow">samples/jax_rs/description_swagger2_web</a>:&#160;Swagger 2.0
web application sample using Swagger2Feature using Spring</li><li><a shape="rect"
class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/description_swagger2_osgi"
rel="nofollow">samples/jax_rs/description_swagger2_osgi</a>:&#160;Swagger 2.0
OSGi application sample using Swagger2Feature using Blueprint<br clear="none"><br
clear="none"></li></ul><p>&#160;</p></div>
+</div></div><h2 id="SwaggerFeature/Swagger2Feature-AutomaticUIActivation">Automatic
UI Activation</h2><p>This feature is available starting from CXF 3.1.7: Adding
a Swagger UI Maven dependency is all what is needed to start accessing Swagger documents with
the help of Swagger UI.</p><p>For example, lets assume a JAX-RS endpoint is published
at '<span>http://host:port/context/services/</span>'.</p><p>Open the
browser and go to '<span>http://host:port/context/services/</span>api-docs?/url=/swagger.json'
which will return a Swagger UI page.</p><p>CXF Services page will also link to
Swagger UI. Go to&#160;'<span>http://host:port/context/services/</span>services'
and follow a Swagger link which will return a Swagger UI page.</p><p>See <a
shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/description_swagger2"
rel="nofollow">samples/jax_rs/description_swagger2</a>,&#160;<a shape="rect"
class="external-link" href=
 "https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/spring_boot"
rel="nofollow">samples/jax_rs/spring_boot</a> and <a shape="rect" class="external-link"
href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/spring_boot_scan"
rel="nofollow">samples/jax_rs/spring_boot_scan</a>&#160;</p><p>Note
that CXF OSGI endpoints can only depend on this feature starting from CXF 3.1.8.</p><h2
id="SwaggerFeature/Swagger2Feature-UnpackingSwaggerUIresources">Unpacking Swagger UI resources</h2><p>Up
until CXF 3.1.7 unpacking Swagger UI resources into the local folder has been the only option.
It is demoed in all CXF Swagger demos but samples/jax_rs/description_swagger2 which</p><p>shows
the automatic UI activation. In CXF 3.1.7: set Swagger2Feature 'supportSwaggerUi' property
to 'false' to disable to automatic UI activation described in the previous section</p><h1
id="SwaggerFeature/Swagger2Feature-Samples">Samples</h1><p><span
 >CXF's distribution contains the following samples.</span></p><ul><li><a
shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/description_swagger"
rel="nofollow">samples/jax_rs/description_swagger</a>: Swagger 1.2 sample using SwaggerFeature
programatically</li><li><a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/description_swagger2"
rel="nofollow">samples/jax_rs/description_swagger2</a>:&#160;Swagger 2.0 standalone
sample using Swagger2Feature programatically</li><li><a shape="rect" class="external-link"
href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/description_swagger2_spring"
rel="nofollow">samples/jax_rs/description_swagger2_spring</a>:&#160;Swagger 2.0
standalone sample using Swagger2Feature using Spring</li><li><a shape="rect"
class="external-link" href="https://github.com/ap
 ache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/description_swagger2_web"
rel="nofollow">samples/jax_rs/description_swagger2_web</a>:&#160;Swagger 2.0
web application sample using Swagger2Feature using Spring</li><li><a shape="rect"
class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jax_rs/description_swagger2_osgi"
rel="nofollow">samples/jax_rs/description_swagger2_osgi</a>:&#160;Swagger 2.0
OSGi application sample using Swagger2Feature using Blueprint<br clear="none"><br
clear="none"></li></ul><p>&#160;</p></div>
            </div>
            <!-- Content -->
          </td>



Mime
View raw message