Author: buildbot
Date: Thu Oct 11 01:00:45 2018
New Revision: 1036240
Log:
Production update by buildbot for cxf
Modified:
websites/production/cxf/content/cache/docs.pageCache
websites/production/cxf/content/docs/openapifeature.html
Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/cxf/content/docs/openapifeature.html
==============================================================================
--- websites/production/cxf/content/docs/openapifeature.html (original)
+++ websites/production/cxf/content/docs/openapifeature.html Thu Oct 11
01:00:45 2018
@@ -119,11 +119,11 @@ Apache CXF -- OpenApiFeature
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1537146967288 {padding: 0px;}
-div.rbtoc1537146967288 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1537146967288 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1539219573706 {padding: 0px;}
+div.rbtoc1539219573706 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1539219573706 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1537146967288">
+/*]]>*/</style></p><div class="toc-macro rbtoc1539219573706">
<ul class="toc-indentation"><li><a shape="rect"
href="#OpenApiFeature-Introduction">Introduction</a></li><li><a shape="rect"
href="#OpenApiFeature-Setup">Setup</a></li><li><a shape="rect"
href="#OpenApiFeature-Properties">Properties</a></li><li><a shape="rect"
href="#OpenApiFeature-ConfiguringfromCode">Configuring from Code</a></li><li><a
shape="rect" href="#OpenApiFeature-ConfiguringfromSpring">Configuring from
Spring</a></li><li><a shape="rect"
href="#OpenApiFeature-ConfiguringinBlueprint">Configuring in
Blueprint</a></li><li><a shape="rect"
href="#OpenApiFeature-ConfiguringinCXFNonSpringJaxrsServlet">Configuring in
CXFNonSpringJaxrsServlet</a></li><li><a shape="rect"
href="#OpenApiFeature-ConfiguringfromPropertyfiles">Configuring from Property
files</a></li><li><a shape="rect"
href="#OpenApiFeature-SpringBootAutoConfiguration">Spring Boot Auto
Configuration</a></li><li><a shape="rect"
href="#OpenApiFeature-EnablingSwaggerUI">Enabling Swagger UI</a></li><li><a
shape="rect" href="#
OpenApiFeature-ConfiguringSwaggerUI(3.2.7+)">Configuring Swagger UI
(3.2.7+)</a></li><li><a shape="rect"
href="#OpenApiFeature-Samples">Samples</a></li></ul>
</div><h2 id="OpenApiFeature-Introduction">Introduction</h2><p>The CXF
<strong>OpenApiFeature</strong> allows you to generate <a shape="rect"
class="external-link"
href="https://github.com/OAI/OpenAPI-Specification/releases/tag/3.0.0";
rel="nofollow">OpenAPI v3.0</a> documents from JAX-RS service endpoints with a
simple configuration. This feature can be configured programmatically in Java
or using Spring or Blueprint beans.</p><h2
id="OpenApiFeature-Setup">Setup</h2><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="brush: java; gutter: false; theme: Default"><dependency>
@@ -246,7 +246,7 @@ feature.setSecurityDefinitions(Collectio
</servlet-mapping>
</web-app></pre>
-</div></div><h2 id="OpenApiFeature-ConfiguringfromPropertyfiles">Configuring
from Property files</h2><p>It is possible to supply the configuration from the
property files. The default location for a properties file is
"<strong>/swagger.properties</strong>". <strong>OpenApiFeature</strong> will
pick it up if it is available, and the location can be overridden with
a<strong> 'propertiesLocation</strong>' property.  Additionally, the
complete OpenAPI configuration could be supplied from the property file
(usually <strong>openapi-configuration.json</strong> or
<strong>openapi-configuration.yml</strong>), controlled by
'<strong>configLocation'</strong> property. By
default, <strong>OpenApiFeature</strong> scans for known OpenAPI
configuration locations and loads them if available (the behavior could be
switched off by setting <strong>scanKnownConfigLocations</strong> to
<strong>false</strong>). Please take into account that there is a certain level
of the overlap between b
oth.</p><p>Note that the properties, if available, do not override the
properties which may have been set as suggested above from the code or
Spring/Blueprint contexts or web.xml. Instead they complement and serve as the
default configuration properties: for example, if some properties have been set
from the code then the values for the same properties found in the properties
file will not be used.</p><h2
id="OpenApiFeature-SpringBootAutoConfiguration">Spring Boot Auto
Configuration</h2><p>Please consult <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 on how to create
<strong>OpenApiFeature</strong> as a @Bean or/and <a shape="rect"
class="external-link"
href="https://github.com/apache/cxf/blob/master/distribution/src/main/release/samples/jax_rs/spring_boot_scan/application/src/main/resources/application.yml#L13";
rel="nofollow">sample
s/jax_rs/spring_boot_scan</a> on how to auto-enable it.</p><h2
id="OpenApiFeature-EnablingSwaggerUI">Enabling Swagger UI</h2><p>Adding a
Swagger UI Maven dependency is all what is needed to start accessing Swagger
documents with the help of Swagger UI.</p><div class="syntaxhighlighter
nogutter xml"><p> </p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+</div></div><h2 id="OpenApiFeature-ConfiguringfromPropertyfiles">Configuring
from Property files</h2><p>It is possible to supply the configuration from the
property files. The default location for a properties file is
"<strong>/swagger.properties</strong>". <strong>OpenApiFeature</strong> will
pick it up if it is available, and the location can be overridden with
a<strong> 'propertiesLocation</strong>' property.  Additionally, the
complete OpenAPI configuration could be supplied from the property file
(usually <strong>openapi-configuration.json</strong> or
<strong>openapi-configuration.yml</strong>), controlled by
'<strong>configLocation'</strong> property. By
default, <strong>OpenApiFeature</strong> scans for known OpenAPI
configuration locations and loads them if available (the behavior could be
switched off by setting <strong>scanKnownConfigLocations</strong> to
<strong>false</strong>). Please take into account that there is a certain level
of the overlap between b
oth.</p><p>Note that the properties, if available, do not override the
properties which may have been set as suggested above from the code or
Spring/Blueprint contexts or web.xml. Instead they complement and serve as the
default configuration properties: for example, if some properties have been set
from the code then the values for the same properties found in the properties
file will not be used.</p><h2
id="OpenApiFeature-SpringBootAutoConfiguration">Spring Boot Auto
Configuration</h2><p>Please consult <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 on how to create
<strong>OpenApiFeature</strong> as a @Bean or/and <a shape="rect"
class="external-link"
href="https://github.com/apache/cxf/blob/master/distribution/src/main/release/samples/jax_rs/spring_boot_scan/application/src/main/resources/application.yml#L13";
rel="nofollow">sample
s/jax_rs/spring_boot_scan</a> on how to auto-enable it. By default, the
<strong>OpenApiCustomizer</strong> instance will be preconfigured for 
<strong>OpenApiFeature</strong> since the base path is often unknown to
CXF.</p><h2 id="OpenApiFeature-EnablingSwaggerUI">Enabling Swagger
UI</h2><p>Adding a Swagger UI Maven dependency is all what is needed to start
accessing Swagger documents with the help of Swagger UI.</p><div
class="syntaxhighlighter nogutter xml"><p> </p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="brush: java; gutter: false; theme: Default"><dependency>
<groupId>org.webjars</groupId>
<artifactId>swagger-ui</artifactId>
