You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by bu...@apache.org on 2020/10/25 00:59:59 UTC
svn commit: r1067102 - in /websites/production/cxf/content:
cache/docs.pageCache docs/dropwizard-metrics.html docs/micrometer.html
docs/springboot.html
Author: buildbot
Date: Sun Oct 25 00:59:58 2020
New Revision: 1067102
Log:
Production update by buildbot for cxf
Modified:
websites/production/cxf/content/cache/docs.pageCache
websites/production/cxf/content/docs/dropwizard-metrics.html
websites/production/cxf/content/docs/micrometer.html
websites/production/cxf/content/docs/springboot.html
Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/cxf/content/docs/dropwizard-metrics.html
==============================================================================
--- websites/production/cxf/content/docs/dropwizard-metrics.html (original)
+++ websites/production/cxf/content/docs/dropwizard-metrics.html Sun Oct 25 00:59:58 2020
@@ -107,14 +107,14 @@ Apache CXF -- Dropwizard Metrics
<td height="100%">
<!-- Content -->
<div class="wiki-content">
-<div id="ConfluenceContent"><h2 id="DropwizardMetrics-/*<![CDATA[*/div.rbtoc1603151796516{padding:0px;}div.rbtoc1603151796516ul{list-style:disc;margin-left:0px;}div.rbtoc1603151796516li{margin-left:0px;padding-left:0px;}/*]]>*/#DropwizardMetrics-MetricsProvider#DropwizardMetrics-MetricsProv"><style type="text/css">/*<![CDATA[*/
-div.rbtoc1603151796516 {padding: 0px;}
-div.rbtoc1603151796516 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1603151796516 li {margin-left: 0px;padding-left: 0px;}
+<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
+div.rbtoc1603587551324 {padding: 0px;}
+div.rbtoc1603587551324 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1603587551324 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></h2><div class="toc-macro rbtoc1603151796516">
-<ul class="toc-indentation"><li><a shape="rect" href="#DropwizardMetrics-"></a></li><li><a shape="rect" href="#DropwizardMetrics-MetricsProvider">Metrics Provider</a></li><li><a shape="rect" href="#DropwizardMetrics-IntegrationwithJAX-WS">Integration with JAX-WS</a></li><li><a shape="rect" href="#DropwizardMetrics-IntegrationwithJAX-RS">Integration with JAX-RS</a></li></ul>
-</div><h2 id="DropwizardMetrics-MetricsProvider">Metrics Provider</h2><h2 id="DropwizardMetrics-IntegrationwithJAX-WS">Integration with JAX-WS</h2><h2 id="DropwizardMetrics-IntegrationwithJAX-RS">Integration with JAX-RS </h2></div>
+/*]]>*/</style></p><div class="toc-macro rbtoc1603587551324">
+<ul class="toc-indentation"><li><a shape="rect" href="#DropwizardMetrics-Introduction">Introduction</a></li><li><a shape="rect" href="#DropwizardMetrics-MetricsProvider">Metrics Provider</a></li><li><a shape="rect" href="#DropwizardMetrics-IntegrationwithJAX-WS">Integration with JAX-WS</a></li><li><a shape="rect" href="#DropwizardMetrics-IntegrationwithJAX-RS">Integration with JAX-RS</a></li></ul>
+</div><h2 id="DropwizardMetrics-Introduction">Introduction</h2><h2 id="DropwizardMetrics-MetricsProvider">Metrics Provider</h2><h2 id="DropwizardMetrics-IntegrationwithJAX-WS">Integration with JAX-WS</h2><h2 id="DropwizardMetrics-IntegrationwithJAX-RS">Integration with JAX-RS</h2></div>
</div>
<!-- Content -->
</td>
Modified: websites/production/cxf/content/docs/micrometer.html
==============================================================================
--- websites/production/cxf/content/docs/micrometer.html (original)
+++ websites/production/cxf/content/docs/micrometer.html Sun Oct 25 00:59:58 2020
@@ -118,11 +118,11 @@ Apache CXF -- Micrometer
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1603584072654 {padding: 0px;}
-div.rbtoc1603584072654 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1603584072654 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1603587550233 {padding: 0px;}
+div.rbtoc1603587550233 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1603587550233 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1603584072654">
+/*]]>*/</style></p><div class="toc-macro rbtoc1603587550233">
<ul class="toc-indentation"><li><a shape="rect" href="#Micrometer-Introduction">Introduction</a></li><li><a shape="rect" href="#Micrometer-MetricsProvider">Metrics Provider</a></li><li><a shape="rect" href="#Micrometer-Configuration">Configuration</a></li><li><a shape="rect" href="#Micrometer-IntegrationwithJAX-WS">Integration with JAX-WS</a></li><li><a shape="rect" href="#Micrometer-IntegrationwithJAX-RS">Integration with JAX-RS</a></li></ul>
</div><h2 id="Micrometer-Introduction">Introduction</h2><p>The <a shape="rect" class="external-link" href="https://micrometer.io/" rel="nofollow">Micrometer</a> metrics library become a de factor instrumentation choice for JVM application. It has been supported by Apache CXF starting from <strong>3.4.1</strong> / <strong>3.3.8 </strong>and above.</p><h2 id="Micrometer-MetricsProvider">Metrics Provider</h2><p>The <a shape="rect" class="external-link" href="https://micrometer.io/" rel="nofollow">Micrometer</a> integration is provided by <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/micrometer/MicrometerMetricsProvider.java" rel="nofollow">MicrometerMetricsProvider</a>.</p><h2 id="Micrometer-Configuration">Configuration</h2><p>There <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/micrometer/Microm
eterMetricsProvider.java" rel="nofollow">MicrometerMetricsProvider</a> supports the following properties (encapsulated inside <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/micrometer/MicrometerMetricsProperties.java" rel="nofollow">MicrometerMetricsProperties</a>).</p><div class="table-wrap"><table class="wrapped confluenceTable"><colgroup span="1"><col span="1"><col span="1"><col span="1"></colgroup><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Property</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th><th colspan="1" rowspan="1" class="confluenceTh">Default</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><strong>autoTimeRequests</strong></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Whether requests handled by CXF should be automatically timed.  If the number of time series emitted grows <br clear="none">too large on account
of request mapping timings, set it to "false" and use <a shape="rect" class="external-link" href="https://github.com/micrometer-metrics/micrometer/blob/master/micrometer-core/src/main/java/io/micrometer/core/annotation/Timed.java" rel="nofollow">@Timed</a> or <a shape="rect" class="external-link" href="https://github.com/micrometer-metrics/micrometer/blob/master/micrometer-core/src/main/java/io/micrometer/core/annotation/TimedSet.java" rel="nofollow">@TimeSet</a> on a per <br clear="none">invocation basis as needed.</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>true</strong></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><strong>requestsMetricName</strong></td><td colspan="1" rowspan="1" class="confluenceTd">Name of the metric for received requests</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>cxf.server.requests</strong></td></tr></tbody></table></div><h2 id="Micrometer-IntegrationwithJAX-WS">Integration with JAX-WS</h2><p>The
typical way to plug <a shape="rect" class="external-link" href="https://micrometer.io/" rel="nofollow">Micrometer</a> integration is by using <a shape="rect" class="external-link" href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceFeature.html" rel="nofollow">WebServiceFeature</a> mechanism, for which there is a dedicated <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsFeature.java" rel="nofollow">MetricsFeature</a> implementation. The snipped below illustrated the basic initialization sequence and set of the dependencies involved.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="brush: java; gutter: false; theme: Default">final MeterRegistry registry = ...; /* Micrometer MeterRegistry instance */
@@ -140,7 +140,7 @@ final MetricsProvider metricsProvider =
EndpointImpl endpoint = new EndpointImpl(bus, new HelloPortImpl(), null, null, new WebServiceFeature[]{
new MetricsFeature(metricsProvider)
});</pre>
-</div></div><p><br clear="none"></p><h2 id="Micrometer-IntegrationwithJAX-RS">Integration with JAX-RS</h2></div>
+</div></div><p><br clear="none"></p><h2 id="Micrometer-IntegrationwithJAX-RS">Integration with JAX-RS</h2><p>No fully supported at the moment</p></div>
</div>
<!-- Content -->
</td>
Modified: websites/production/cxf/content/docs/springboot.html
==============================================================================
--- websites/production/cxf/content/docs/springboot.html (original)
+++ websites/production/cxf/content/docs/springboot.html Sun Oct 25 00:59:58 2020
@@ -119,13 +119,13 @@ Apache CXF -- SpringBoot
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1524513429227 {padding: 0px;}
-div.rbtoc1524513429227 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1524513429227 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1603587546154 {padding: 0px;}
+div.rbtoc1603587546154 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1603587546154 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1524513429227">
+/*]]>*/</style></p><div class="toc-macro rbtoc1603587546154">
<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>
+<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-Actuator">Actuator</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 JAX-RS Starter</a>
<ul class="toc-indentation"><li><a shape="rect" href="#SpringBoot-Features.1">Features</a></li><li><a shape="rect" href="#SpringBoot-Setup.1">Setup</a></li><li><a shape="rect" href="#SpringBoot-AdditionalConfiguration.1">Additional Configuration</a></li><li><a shape="rect" href="#SpringBoot-APIDocumentation.1">API Documentation</a>
<ul class="toc-indentation"><li><a shape="rect" href="#SpringBoot-Swagger">Swagger</a></li><li><a shape="rect" href="#SpringBoot-WADL">WADL</a></li></ul>
@@ -134,13 +134,13 @@ div.rbtoc1524513429227 li {margin-left:
</li></ul>
</li></ul>
</div><h1 id="SpringBoot-SpringBootCXFJAX-WSStarter">Spring Boot CXF JAX-WS Starter</h1><h2 id="SpringBoot-Features">Features</h2><p>Registers CXFServlet with a  "/services/*" URL pattern for serving CXF JAX-WS endpoints.</p><h2 id="SpringBoot-Setup">Setup</h2><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-WS Starter</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><dependency>
+<pre class="brush: xml; gutter: false; theme: Default"><dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-spring-boot-starter-jaxws</artifactId>
<version>3.1.12</version>
</dependency></pre>
-</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  "/services"), etc.</p><p>If needed, one can use Spring ImportResource annotation to import the existing JAX-WS contexts available on the classpath.</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">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">package sample.ws;
+</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  "/services"), etc.</p><p>If needed, one can use Spring ImportResource annotation to import the existing JAX-WS contexts available on the classpath.</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-Actuator">Actuator</h2><p>When the presence of the <a shape="rect" class="external-link" href="https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html" rel="nofollow">Spring Boot Actuator</a> is detected, the application may benefit from metrics support auto-configuration (based on  <a shape="rect" class="external-link" href="https://micrometer.io/" rel="nofollow">Micrometer</a> library). The instrumentation layer automatically (or programmatically) tracks the server-side metrics with respect to requests processing, and exposes it along with other metrics. For more details, please check <a shape="rect" href="micrometer.html">Micrometer Integration</a> documentation.</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">
+<pre class="brush: java; gutter: false; theme: Default">package sample.ws;
import javax.xml.ws.Endpoint;
import org.apache.cxf.Bus;
@@ -163,14 +163,14 @@ public class WebServiceConfig {
return endpoint;
}
}</pre>
-</div></div><p> </p><p>Having a CXF JAX-WS starter alongside this Configuration is sufficient for enabling a CXF JAX-WS endpoint which will respond to SOAP request URI such as</p><p>"http://localhost:8080/services/Hello".</p><p>Please also see a <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jaxws_spring_boot" rel="nofollow">JAX-WS Spring Boot</a> demo.</p><h1 id="SpringBoot-SpringBootCXFJAX-RSStarter">Spring Boot CXF JAX-RS Starter</h1><h2 id="SpringBoot-Features.1">Features</h2><p>Registers CXF Servlet with a  "/services/*" URL pattern for serving CXF JAX-RS endpoints.</p><p>Optionally auto-discovers JAX-RS root resources and providers and creates a JAX-RS endpoint.</p><p>Note the use of CXF JAX-RS Clients in SpringBoot Application is covered in <a shape="rect" href="jaxrsclientspringboot.html">this section</a>.</p><h2 id="SpringBoot-Setup.1">Setup</h2><div class="code panel pdl" style="bor
der-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-RS Starter</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><dependency>
+</div></div><p><br clear="none"></p><p>Having a CXF JAX-WS starter alongside this Configuration is sufficient for enabling a CXF JAX-WS endpoint which will respond to SOAP request URI such as</p><p>"http://localhost:8080/services/Hello".</p><p>Please also see a <a shape="rect" class="external-link" href="https://github.com/apache/cxf/tree/master/distribution/src/main/release/samples/jaxws_spring_boot" rel="nofollow">JAX-WS Spring Boot</a> demo.</p><h1 id="SpringBoot-SpringBootCXFJAX-RSStarter">Spring Boot CXF JAX-RS Starter</h1><h2 id="SpringBoot-Features.1">Features</h2><p>Registers CXF Servlet with a  "/services/*" URL pattern for serving CXF JAX-RS endpoints.</p><p>Optionally auto-discovers JAX-RS root resources and providers and creates a JAX-RS endpoint.</p><p>Note the use of CXF JAX-RS Clients in SpringBoot Application is covered in <a shape="rect" href="jaxrsclientspringboot.html">this section</a>.</p><h2 id="SpringBoot-Setup.1">Setup</h2><div class="code panel pdl"
style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-RS Starter</b></div><div class="codeContent panelContent pdl">
+<pre class="brush: xml; gutter: false; theme: Default"><dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-spring-boot-starter-jaxrs</artifactId>
<version>3.1.12</version>
</dependency></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>Use "<strong>cxf.servlet.init</strong>" map property to customize CXFServlet properties such as "services-list-path" (available by default at  "/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 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.component-scan</strong>-<strong>packages</strong>" property to restrict which of the auto-discovered Spring components are accepted as JAX-RS resource or provider classes. It sets a comma-separated list of the packages that a given bean instance's class must be in. Note, this property, if set, is only effective if a given bean is a singleton. It can be used alongside or as an alternative to the "<strong>cxf.jaxrs.component-scan</strong>-<strong>beans</strong>" property. This property is available starting from CXF 3.1.11.</p><p>Use "<strong>cxf.jaxrs.component-scan</strong>-<strong>beans</strong>" property to restrict which of the auto-discovered Spring components are accepted as JAX-RS resource or provider classes. It sets a comma-separated list of the accepted bean names - the auto-discovered component will only be accepted if its bean name is in this list. It can be used alongs
ide or as an alternative to the "<strong>cxf.jaxrs.component-scan</strong>-<strong>packages</strong>" property. This property is available starting from CXF 3.1.11.</p><p>Use "<strong>cxf.jaxrs.classes-scan</strong>" property to create a JAX-RS endpoint from the auto-discovered 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><p>If needed, instead of having the resources auto-di
scovered,  one can use Spring ImportResource annotation to import the existing JAX-RS contexts available on the classpath.</p><h2 id="SpringBoot-APIDocumentation.1">API Documentation</h2><h3 id="SpringBoot-Swagger">Swagger</h3><p>See CXF <a shape="rect" href="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_sca
n/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">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">package sample.rs.service;
+<pre class="brush: java; gutter: false; theme: Default">package sample.rs.service;
import java.util.Arrays;
import org.apache.cxf.Bus;
@@ -205,13 +205,13 @@ public class SampleRestApplication {
return endpoint.create();
}
}</pre>
-</div></div><p> </p><p>Having a CXF JAX-RS starter alongside this Configuration is sufficient for enabling a CXF JAX-RS endpoint which will respond to HTTP request URI such as</p><p>"<a shape="rect" class="external-link" href="http://localhost:8080/services/Hello" rel="nofollow">http://localhost:8080/services/sayHello/ApacheCxfUser</a>". The above code also makes Swagger docs available at "<a shape="rect" class="external-link" href="http://localhost:8080/services/Hello" rel="nofollow">http://localhost:8080/services/swagger.json</a>".</p><p>Please also see a <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">JAX-RS Spring Boot</a> demo.</p><p> </p><h3 id="SpringBoot-AutoConfiguration">Auto Configuration</h3><p>Spring Boot Application example shown in the Manual Configuration section can be simplified if the auto-discovery is enabled.</p><p>For example, given the
following application.yml properties:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Application Properties</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: text; gutter: false; theme: Default" style="font-size:12px;"> cxf:
+</div></div><p><br clear="none"></p><p>Having a CXF JAX-RS starter alongside this Configuration is sufficient for enabling a CXF JAX-RS endpoint which will respond to HTTP request URI such as</p><p>"<a shape="rect" class="external-link" href="http://localhost:8080/services/Hello" rel="nofollow">http://localhost:8080/services/sayHello/ApacheCxfUser</a>". The above code also makes Swagger docs available at "<a shape="rect" class="external-link" href="http://localhost:8080/services/Hello" rel="nofollow">http://localhost:8080/services/swagger.json</a>".</p><p>Please also see a <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">JAX-RS Spring Boot</a> demo.</p><p><br clear="none"></p><h3 id="SpringBoot-AutoConfiguration">Auto Configuration</h3><p>Spring Boot Application example shown in the Manual Configuration section can be simplified if the auto-discovery is enabled.</p><p>F
or example, given the following application.yml properties:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Application Properties</b></div><div class="codeContent panelContent pdl">
+<pre class="brush: text; gutter: false; theme: Default"> cxf:
jaxrs:
component-scan: true
classes-scan-packages: org.apache.cxf.jaxrs.swagger</pre>
-</div></div><p> </p><p>the application becomes simply:</p><p> </p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-RS Auto Configuration</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">package sample.rs.service;
+</div></div><p><br clear="none"></p><p>the application becomes simply:</p><p><br clear="none"></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>JAX-RS Auto Configuration</b></div><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default">package sample.rs.service;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@@ -221,7 +221,7 @@ public class SampleScanRestApplication {
SpringApplication.run(SampleScanRestApplication.class, args);
}
}</pre>
-</div></div><p> </p><p>This application will enable a CXF JAX-RS endpoint which will respond to HTTP request URI such as</p><p>"<a shape="rect" class="external-link" href="http://localhost:8080/services/Hello" rel="nofollow">http://localhost:8080/services/sayHello/ApacheCxfUser</a>". The above code also makes Swagger docs available at "<a shape="rect" class="external-link" href="http://localhost:8080/services/Hello" rel="nofollow">http://localhost:8080/services/swagger.json</a>".</p><p>Please also see 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><p> </p></div>
+</div></div><p><br clear="none"></p><p>This application will enable a CXF JAX-RS endpoint which will respond to HTTP request URI such as</p><p>"<a shape="rect" class="external-link" href="http://localhost:8080/services/Hello" rel="nofollow">http://localhost:8080/services/sayHello/ApacheCxfUser</a>". The above code also makes Swagger docs available at "<a shape="rect" class="external-link" href="http://localhost:8080/services/Hello" rel="nofollow">http://localhost:8080/services/swagger.json</a>".</p><p>Please also see 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><p><br clear="none"></p></div>
</div>
<!-- Content -->
</td>