Author: buildbot
Date: Wed Apr 11 17:57:24 2018
New Revision: 1028253

Log:
Production update by buildbot for cxf

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

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

Modified: websites/production/cxf/content/docs/swagger2feature.html
==============================================================================
--- websites/production/cxf/content/docs/swagger2feature.html (original)
+++ websites/production/cxf/content/docs/swagger2feature.html Wed Apr 11 
17:57:24 2018
@@ -118,11 +118,11 @@ Apache CXF -- Swagger2Feature
            <!-- Content -->
            <div class="wiki-content">
 <div id="ConfluenceContent"><h1 
id="Swagger2Feature-Swagger2Feature">Swagger2Feature</h1><p><style 
type="text/css">/*<![CDATA[*/
-div.rbtoc1523213814463 {padding: 0px;}
-div.rbtoc1523213814463 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1523213814463 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1523469406494 {padding: 0px;}
+div.rbtoc1523469406494 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1523469406494 li {margin-left: 0px;padding-left: 0px;}
 
-/*]]>*/</style></p><div class="toc-macro rbtoc1523213814463">
+/*]]>*/</style></p><div class="toc-macro rbtoc1523469406494">
 <ul class="toc-indentation"><li><a shape="rect" 
href="#Swagger2Feature-Swagger2Feature">Swagger2Feature</a></li><li><a 
shape="rect" href="#Swagger2Feature-Setup">Setup</a></li><li><a shape="rect" 
href="#Swagger2Feature-Properties">Properties</a></li><li><a shape="rect" 
href="#Swagger2Feature-ConfiguringfromCode">Configuring from 
Code</a></li><li><a shape="rect" 
href="#Swagger2Feature-ConfiguringinSpring">Configuring in 
Spring</a></li><li><a shape="rect" 
href="#Swagger2Feature-ConfiguringinBlueprint">Configuring in 
Blueprint</a></li><li><a shape="rect" 
href="#Swagger2Feature-ConfiguringinCXFNonSpringJaxrsServlet">Configuring in 
CXFNonSpringJaxrsServlet</a></li><li><a shape="rect" 
href="#Swagger2Feature-New:ConfiguringfromPropertiesfile">New: Configuring from 
Properties file</a></li><li><a shape="rect" 
href="#Swagger2Feature-EnablinginSpringBoot">Enabling in Spring 
Boot</a></li><li><a shape="rect" 
href="#Swagger2Feature-AccessingSwaggerDocuments">Accessing Swagger 
Documents</a></li><l
 i><a shape="rect" href="#Swagger2Feature-EnablingSwaggerUI">Enabling Swagger 
UI</a>
 <ul class="toc-indentation"><li><a shape="rect" 
href="#Swagger2Feature-AutomaticUIActivation">Automatic UI 
Activation</a></li><li><a shape="rect" 
href="#Swagger2Feature-UnpackingSwaggerUIresources">Unpacking Swagger UI 
resources</a></li></ul>
 </li><li><a shape="rect" href="#Swagger2Feature-ReverseProxy">Reverse 
Proxy</a></li><li><a shape="rect" 
href="#Swagger2Feature-ConvertingtoOpenAPIJSON">Converting to OpenAPI 
JSON</a></li><li><a shape="rect" 
href="#Swagger2Feature-Samples">Samples</a></li></ul>
@@ -134,19 +134,19 @@ div.rbtoc1523213814463 li {margin-left:
 &lt;/dependency&gt;
 
 </pre>
-</div></div><p>Note that a <strong>cxf-rt-rs-service-description</strong> 
needs to be used if older CXF 3.1.x versions are used.</p><p>&#160;</p><h1 
id="Swagger2Feature-Properties">Properties</h1><p><span style="line-height: 
1.4285715;">The following optional parameters can be configured in 
Swagger2Feature</span></p><p><span style="line-height: 1.4285715;">Note some 
properties listed below are not available or used differently in 
SwaggerFeature, as the corresponding properties are used differently in Swagger 
2.0 and Swagger 1.2. Please refer to the corresponding Swagger documentation 
for more information.)</span></p><div class="table-wrap"><table 
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" 
class="confluenceTh">Name</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">basePath</td><td colspan="1" rowspan="1" 
class="confluenceTd">the
  context root path<sup>+</sup></td><td colspan="1" rowspan="1" 
class="confluenceTd">null</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">contact</td><td colspan="1" rowspan="1" 
class="confluenceTd">the contact information<span>+</span></td><td colspan="1" 
rowspan="1" class="confluenceTd">"us...@cxf.apache.org"</td></tr><tr><td 
colspan="1" rowspan="1" class="confluenceTd">description</td><td colspan="1" 
rowspan="1" class="confluenceTd">the description<span>+</span></td><td 
colspan="1" rowspan="1" class="confluenceTd">"The Application"</td></tr><tr><td 
colspan="1" rowspan="1" class="confluenceTd">filterClass</td><td colspan="1" 
rowspan="1" class="confluenceTd">a security filter<span>+</span></td><td 
colspan="1" rowspan="1" class="confluenceTd">null</td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd">host</td><td colspan="1" rowspan="1" 
class="confluenceTd">the host and port<span>+</span></td><td colspan="1" 
rowspan="1" class="confluenceTd">null</td></tr><tr><td
  colspan="1" rowspan="1" class="confluenceTd">ignoreRoutes</td><td colspan="1" 
rowspan="1" class="confluenceTd">excludes specific paths when scanning all 
resources (see scanAllResources)<span>+</span><span>+</span></td><td 
colspan="1" rowspan="1" class="confluenceTd">null</td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd">license</td><td colspan="1" rowspan="1" 
class="confluenceTd">the license<span>+</span></td><td colspan="1" rowspan="1" 
class="confluenceTd">"Apache 2.0 License"</td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd">licenceUrl</td><td colspan="1" rowspan="1" 
class="confluenceTd">the license URL<span>+</span></td><td colspan="1" 
rowspan="1" class="confluenceTd">"<span 
class="nolink">http://www.apache.org/licenses/LICENSE-2.0.html</span>"</td></tr><tr><td
 colspan="1" rowspan="1" class="confluenceTd">prettyPrint</td><td colspan="1" 
rowspan="1" class="confluenceTd">when generating swagger.json, pretty-print the 
json document<span>+</span></td><td cols
 pan="1" rowspan="1" class="confluenceTd">false</td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd">resourcePackage</td><td colspan="1" 
rowspan="1" class="confluenceTd">a list of comma separated package names where 
resources must be scanned<span>+</span></td><td colspan="1" rowspan="1" 
class="confluenceTd">a list of service classes configured at the 
endpoint</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">runAsFilter</td><td colspan="1" rowspan="1" 
class="confluenceTd">runs the feature as a filter</td><td colspan="1" 
rowspan="1" class="confluenceTd">false</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">scan</td><td colspan="1" rowspan="1" 
class="confluenceTd">generates the swagger documentation<span>+</span></td><td 
colspan="1" rowspan="1" class="confluenceTd">true</td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd">scanAllResources</td><td colspan="1" 
rowspan="1" class="confluenceTd">scans all resources including non-annotated 
JAX-RS r
 esources<span>+</span><span>+</span></td><td colspan="1" rowspan="1" 
class="confluenceTd">false</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">schemes</td><td colspan="1" rowspan="1" 
class="confluenceTd">the protocol schemes<span>+</span></td><td colspan="1" 
rowspan="1" class="confluenceTd">null</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">termsOfServiceUrl</td><td colspan="1" rowspan="1" 
class="confluenceTd">the terms of service URL<span>+</span></td><td colspan="1" 
rowspan="1" class="confluenceTd">null</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">title</td><td colspan="1" rowspan="1" 
class="confluenceTd">the title<span>+</span></td><td colspan="1" rowspan="1" 
class="confluenceTd">"Sample REST Application"</td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd">version</td><td colspan="1" rowspan="1" 
class="confluenceTd">the version<span>+</span></td><td colspan="1" rowspan="1" 
class="confluenceTd">"1.0.0"</td></tr></tbody></ta
 ble></div><p>Note: those descriptions marked with&#160;<span>+ correspond to 
the properties defined in Swagger's BeanConfig, and those marked 
with&#160;<span>+</span><span>+ correspond to&#160;the properties defined in 
Swagger's ReaderConfig.</span></span></p><h1 
id="Swagger2Feature-ConfiguringfromCode">Configuring from 
Code</h1><p>&#160;</p><div class="code panel pdl" style="border-width: 
1px;"><div class="codeContent panelContent pdl">
+</div></div><p>Note that a <strong>cxf-rt-rs-service-description</strong> 
needs to be used if older CXF 3.1.x versions are used.</p><p>&#160;</p><h1 
id="Swagger2Feature-Properties">Properties</h1><p><span style="line-height: 
1.4285715;">The following optional parameters can be configured in 
Swagger2Feature</span></p><p><span style="line-height: 1.4285715;">Note some 
properties listed below are not available or used differently in 
SwaggerFeature, as the corresponding properties are used differently in Swagger 
2.0 and Swagger 1.2. Please refer to the corresponding Swagger documentation 
for more information.)</span></p><div class="table-wrap"><table 
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" 
class="confluenceTh">Name</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">basePath</td><td colspan="1" rowspan="1" 
class="confluenceTd">the
  context root path<sup>+</sup></td><td colspan="1" rowspan="1" 
class="confluenceTd">null</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">contact</td><td colspan="1" rowspan="1" 
class="confluenceTd">the contact information<span>+</span></td><td colspan="1" 
rowspan="1" class="confluenceTd">null (in CXF 3.1.x 
"us...@cxf.apache.org")</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">description</td><td colspan="1" rowspan="1" 
class="confluenceTd">the description<span>+</span></td><td colspan="1" 
rowspan="1" class="confluenceTd">null (in CXF 3.1.x "The 
Application")</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">filterClass</td><td colspan="1" rowspan="1" 
class="confluenceTd">a security filter<span>+</span></td><td colspan="1" 
rowspan="1" class="confluenceTd">null</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">host</td><td colspan="1" rowspan="1" 
class="confluenceTd">the host and port<span>+</span></td><td colspan="1" 
rowspan="1" cl
 ass="confluenceTd">null</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">ignoreRoutes</td><td colspan="1" rowspan="1" 
class="confluenceTd">excludes specific paths when scanning all resources (see 
scanAllResources)<span>+</span><span>+</span></td><td colspan="1" rowspan="1" 
class="confluenceTd">null</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">license</td><td colspan="1" rowspan="1" 
class="confluenceTd">the license<span>+</span></td><td colspan="1" rowspan="1" 
class="confluenceTd">"Apache 2.0 License"</td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd">licenceUrl</td><td colspan="1" rowspan="1" 
class="confluenceTd">the license URL<span>+</span></td><td colspan="1" 
rowspan="1" class="confluenceTd">"<span 
class="nolink">http://www.apache.org/licenses/LICENSE-2.0.html</span>"</td></tr><tr><td
 colspan="1" rowspan="1" class="confluenceTd">prettyPrint</td><td colspan="1" 
rowspan="1" class="confluenceTd">when generating swagger.json, pretty-print the 
 json document<span>+</span></td><td colspan="1" rowspan="1" 
class="confluenceTd">false</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">resourcePackage</td><td colspan="1" rowspan="1" 
class="confluenceTd">a list of comma separated package names where resources 
must be scanned<span>+</span></td><td colspan="1" rowspan="1" 
class="confluenceTd">a list of service classes configured at the 
endpoint</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">runAsFilter</td><td colspan="1" rowspan="1" 
class="confluenceTd">runs the feature as a filter</td><td colspan="1" 
rowspan="1" class="confluenceTd">false</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">scan</td><td colspan="1" rowspan="1" 
class="confluenceTd">generates the swagger documentation<span>+</span></td><td 
colspan="1" rowspan="1" class="confluenceTd">true</td></tr><tr><td colspan="1" 
rowspan="1" class="confluenceTd">scanAllResources</td><td colspan="1" 
rowspan="1" class="confluenceTd">scans all re
 sources including non-annotated JAX-RS 
resources<span>+</span><span>+</span></td><td colspan="1" rowspan="1" 
class="confluenceTd">false</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">schemes</td><td colspan="1" rowspan="1" 
class="confluenceTd">the protocol schemes<span>+</span></td><td colspan="1" 
rowspan="1" class="confluenceTd">null</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">termsOfServiceUrl</td><td colspan="1" rowspan="1" 
class="confluenceTd">the terms of service URL<span>+</span></td><td colspan="1" 
rowspan="1" class="confluenceTd">null</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">title</td><td colspan="1" rowspan="1" 
class="confluenceTd">the title<span>+</span></td><td colspan="1" rowspan="1" 
class="confluenceTd">null (in CXF 3.1.x "Sample REST 
Application")</td></tr><tr><td colspan="1" rowspan="1" 
class="confluenceTd">version</td><td colspan="1" rowspan="1" 
class="confluenceTd">the version<span>+</span></td><td colspan="1" ro
 wspan="1" class="confluenceTd">null (in CXF 3.1.x 
"1.0.0")</td></tr></tbody></table></div><p>Note: those descriptions marked 
with&#160;<span>+ correspond to the properties defined in Swagger's BeanConfig, 
and those marked with&#160;<span>+</span><span>+ correspond to&#160;the 
properties defined in Swagger's ReaderConfig.</span></span></p><h1 
id="Swagger2Feature-ConfiguringfromCode">Configuring from 
Code</h1><p>&#160;</p><div class="code panel pdl" style="border-width: 
1px;"><div class="codeContent panelContent pdl">
 <pre class="brush: java; gutter: false; theme: Default" 
style="font-size:12px;">import org.apache.cxf.frontend.ServerFactoryBean;
 import org.apache.cxf.jaxrs.swagger.Swagger2Feature;
 ...
 
-    Swagger2Feature feature = new Swagger2Feature();
+Swagger2Feature feature = new Swagger2Feature();
 
-    // customize some of the properties
-    feature.setBasePath("/api");
+// customize some of the properties
+feature.setBasePath("/api");
        
-       // add this feature to the endpoint (e.g., to ServerFactoryBean's 
features) 
-       ServerFactoryBean sfb = new ServerFactoryBean();
-       sfb.getFeatures().add(feature);</pre>
+// add this feature to the endpoint (e.g., to ServerFactoryBean's features) 
+ServerFactoryBean sfb = new ServerFactoryBean();
+sfb.getFeatures().add(feature);</pre>
 </div></div><p>&#160;</p><h1 
id="Swagger2Feature-ConfiguringinSpring">Configuring in 
Spring</h1><p>&#160;</p><div class="code panel pdl" style="border-width: 
1px;"><div class="codeContent panelContent pdl">
 <pre class="brush: java; gutter: false; theme: Default" 
style="font-size:12px;">&lt;beans 
xmlns="http://www.springframework.org/schema/beans";
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; 
xmlns:cxf="http://cxf.apache.org/core";


Reply via email to