Author: buildbot
Date: Sun Apr 8 16:57:32 2018
New Revision: 1028070
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 Sun Apr 8
16:57:32 2018
@@ -34,6 +34,7 @@
<script src='/resources/highlighter/scripts/shCore.js'></script>
<script src='/resources/highlighter/scripts/shBrushJava.js'></script>
<script src='/resources/highlighter/scripts/shBrushXml.js'></script>
+<script src='/resources/highlighter/scripts/shBrushBash.js'></script>
<script>
SyntaxHighlighter.defaults['toolbar'] = false;
SyntaxHighlighter.all();
@@ -117,20 +118,131 @@ Apache CXF -- OpenApiFeature
<td height="100%">
<!-- Content -->
<div class="wiki-content">
-<div id="ConfluenceContent"><h2
id="OpenApiFeature-/*<![CDATA[*/div.rbtoc1523202967396{padding:0px;}div.rbtoc1523202967396ul{list-style:disc;margin-left:0px;}div.rbtoc1523202967396li{margin-left:0px;padding-left:0px;}/*]]>*/#OpenApiFeature-Introduction#OpenApiFeature-IntroductionSetup#OpenA"><style
type="text/css">/*<![CDATA[*/
-div.rbtoc1523202967396 {padding: 0px;}
-div.rbtoc1523202967396 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1523202967396 li {margin-left: 0px;padding-left: 0px;}
+<div id="ConfluenceContent"><h2
id="OpenApiFeature-/*<![CDATA[*/div.rbtoc1523206614834{padding:0px;}div.rbtoc1523206614834ul{list-style:disc;margin-left:0px;}div.rbtoc1523206614834li{margin-left:0px;padding-left:0px;}/*]]>*/#OpenApiFeature-Introduction#OpenApiFeature-IntroductionSetup#OpenA"><style
type="text/css">/*<![CDATA[*/
+div.rbtoc1523206614834 {padding: 0px;}
+div.rbtoc1523206614834 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1523206614834 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></h2><div class="toc-macro rbtoc1523202967396">
-<ul class="toc-indentation"><li><a shape="rect"
href="#OpenApiFeature-"></a></li><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-SwaggerToOpenApiConversionFilter">SwaggerToOpenApiConversionFilter</a></li></ul>
+/*]]>*/</style></h2><div class="toc-macro rbtoc1523206614834">
+<ul class="toc-indentation"><li><a shape="rect"
href="#OpenApiFeature-"></a></li><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></ul>
+<ul><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></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"
style="font-size:12px;"><dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-rs-service-description-openapi-v3</artifactId>
<version>3.2.4</version>
</dependency></pre>
-</div></div><p>The <strong>cxf-rt-rs-service-description-openapi-v3</strong>
is only available in <strong>3.2.x</strong> and above due to Java 8 baseline.
For older releases, as well as for the users of older Swagger specifications
1.x/2.x, the is dedicated converter provided: <span
class="confluence-link">SwaggerToOpenApiConversionFilter</span>.</p><h2
id="OpenApiFeature-Properties">Properties</h2><p><span>The following optional
parameters can be configured in <strong>OpenApiFeature</strong>. Note that
although there are some similarities with Swagger specifications 1.x/2.x, <a
shape="rect" class="external-link"
href="https://github.com/OAI/OpenAPI-Specification/releases/tag/3.0.0";
rel="nofollow">OpenAPI v3.0</a> is a significant revamp of the specification
(in a good sense of it).</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 value (if
>applicable)</th></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"> </td><td colspan="1" rowspan="1"
>class="confluenceTd"> </td><td colspan="1" rowspan="1"
>class="confluenceTd"> </td></tr></tbody></table></div><p><span><br
>clear="none"></span></p><h2
>id="OpenApiFeature-SwaggerToOpenApiConversionFilter">SwaggerToOpenApiConversionFilter</h2></div>
+</div></div><p>The <strong>cxf-rt-rs-service-description-openapi-v3</strong>
is only available in <strong>3.2.x</strong> and above due to Java 8 baseline.
For older releases, as well as for the users of older Swagger specifications
1.x/2.x, the is dedicated converter provided: <span
class="confluence-link">org.apache.cxf.jaxrs.swagger.openapi.SwaggerToOpenApiConversionFilter</span>.</p><h2
id="OpenApiFeature-Properties">Properties</h2><p><span>The following optional
parameters can be configured in <strong>OpenApiFeature</strong>. Note that
although there are some similarities with Swagger specifications 1.x/2.x, <a
shape="rect" class="external-link"
href="https://github.com/OAI/OpenAPI-Specification/releases/tag/3.0.0";
rel="nofollow">OpenAPI v3.0</a> is a significant revamp of the specification
(in a good sense of it).</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 value (if applicable)</th><th colspan="1"
rowspan="1" class="confluenceTh">Sample value (if applicable)</th></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">securityDefinitions</td><td
colspan="1" rowspan="1" class="confluenceTd">a list of security
definitions<strong>*</strong></td><td colspan="1" rowspan="1"
class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd"><p>["basicAuth" -> new
SecurityScheme().type(Type.HTTP))]</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">customizer</td><td colspan="1" rowspan="1"
class="confluenceTd">the customizer class instance</td><td colspan="1"
rowspan="1" class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd">new OpenApiCustomizer()</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">swaggerUiMavenGroupAndArtifact</td><td
colspan="1" rowspan="1" class="confluenceTd">t
he Maven artifacts to pinpoint SwaggerUI</td><td colspan="1" rowspan="1"
class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd">"org.webjars.swagger-ui'</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">swaggerUiVersion</td><td colspan="1"
rowspan="1" class="confluenceTd">the version of SwaggerUI</td><td colspan="1"
rowspan="1" class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd">"3.13.0"</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">supportSwaggerUi</td><td colspan="1" rowspan="1"
class="confluenceTd">turns on/off SwaggerUI support</td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>false</strong></td><td colspan="1"
rowspan="1" class="confluenceTd">false</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">filterClass</td><td colspan="1" rowspan="1"
class="confluenceTd">a security
filter<strong>*</strong><strong>*</strong></td><td colspan="1" rowspan="1"
class="confluenceTd">null</td><t
d colspan="1" rowspan="1"
class="confluenceTd">"com.example.filter.SampleFilter"</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">resourceClasses</td><td
colspan="1" rowspan="1" class="confluenceTd">a list of resource classes which
must be scanned<strong>*</strong><strong>*</strong></td><td colspan="1"
rowspan="1" class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd">["com.example.rest.SampleResource"]</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">resourcePackages</td><td
colspan="1" rowspan="1" class="confluenceTd">a list of package names where
resources must be scanned<strong>*</strong><strong>*</strong></td><td
colspan="1" rowspan="1" class="confluenceTd">null</td><td colspan="1"
rowspan="1" class="confluenceTd">["com.example.rest"]</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">ignoredRoutes</td><td colspan="1"
rowspan="1" class="confluenceTd">excludes specific paths when scanning all
resources (see scanAllReso
urces)<span><strong>*</strong><strong>*</strong></span></td><td colspan="1"
rowspan="1" class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd">["/api/test"]</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">prettyPrint</td><td colspan="1" rowspan="1"
class="confluenceTd">when generating openapi.json, pretty-print the JSON
document<span><strong>*</strong><strong>*</strong></span></td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>true</strong></td><td colspan="1"
rowspan="1" class="confluenceTd">true</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"><strong>false</strong></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">Scan all JAX-RS resources automatic
ally</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>true</strong></td><td colspan="1" rowspan="1"
class="confluenceTd">true</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">readAllResources</td><td colspan="1" rowspan="1"
class="confluenceTd"><span>Read all operations also with no
@Operation<strong>*</strong><strong>*</strong></span><span> </span></td><td
colspan="1" rowspan="1" class="confluenceTd"><strong>true</strong></td><td
colspan="1" rowspan="1" class="confluenceTd">true</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><strong>*</strong></span></td><td colspan="1" rowspan="1"
class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd">null</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">licenseUrl</td><td colspan="1" rowspan="1"
class="confluenceTd">the license URL<strong>*</strong></td><td colspan="
1" rowspan="1" class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd">"<span class="nolink"><a shape="rect"
class="external-link"
href="http://www.apache.org/licenses/LICENSE-2.0.html";>http://www.apache.org/licenses/LICENSE-2.0.html</a></span>"</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">license</td><td colspan="1"
rowspan="1" class="confluenceTd">the
license<span><strong>*</strong></span></td><td colspan="1" rowspan="1"
class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd">"Apache 2.0 License"</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">contactUrl</td><td colspan="1" rowspan="1"
class="confluenceTd">the contact link<strong>*</strong></td><td colspan="1"
rowspan="1" class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd">null</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">contactEmail</td><td colspan="1" rowspan="1"
class="confluenceTd">the contact email<strong>
*</strong></td><td colspan="1" rowspan="1" class="confluenceTd">null</td><td
colspan="1" rowspan="1" class="confluenceTd">"users@<a shape="rect"
href="http://cxf.apache.org";>cxf.apache.org</a>"</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">contactName</td><td colspan="1" rowspan="1"
class="confluenceTd">the contact name<strong>*</strong></td><td colspan="1"
rowspan="1" class="confluenceTd">null</td><td colspan="1" rowspan="1"
class="confluenceTd">null</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">description</td><td colspan="1" rowspan="1"
class="confluenceTd">the description<span><strong>*</strong></span></td><td
colspan="1" rowspan="1" class="confluenceTd">null</td><td colspan="1"
rowspan="1" class="confluenceTd">"The Sample REST Application with OpenAPI
integration"</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">title</td><td colspan="1" rowspan="1"
class="confluenceTd">the title<span><strong>*</strong></span></td><td
colspan="1" row
span="1" class="confluenceTd">null</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><strong>*</strong></span></td><td
colspan="1" rowspan="1" class="confluenceTd">null</td><td colspan="1"
rowspan="1"
class="confluenceTd">"1.0.0"</td></tr></tbody></table></div><p><span><strong>*</strong>
- t<span>he properties are defined in the OpenAPI
class</span></span></p><p><span><span> </span><span><strong>*</strong></span><span><strong>*</strong></span>
- <span>t<span>he properties are defined in the SwaggerConfiguration
class</span></span></span></p><h2
id="OpenApiFeature-ConfiguringfromCode">Configuring from Code</h2><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.jaxrs.openapi.OpenApiFeature;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import io.swagger.v3.oas.models.security.SecurityScheme.Type;
+
+...
+
+final OpenApiFeature feature = new OpenApiFeature();
+feature.setContactEmail("c...@apache.org");
+feature.setLicense("Apache 2.0 License");
+feature.setLicenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html";);
+feature.setSecurityDefinitions(Collections.singletonMap("basicAuth",new
SecurityScheme().type(Type.HTTP)));</pre>
+</div></div><p> </p><h1
id="OpenApiFeature-ConfiguringfromSpring">Configuring from Spring</h1><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;"><beans
xmlns="http://www.springframework.org/schema/beans";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xmlns:cxf="http://cxf.apache.org/core";
+ xmlns:jaxrs="http://cxf.apache.org/jaxrs";
+ xsi:schemaLocation="http://cxf.apache.org/core
http://cxf.apache.org/schemas/core.xsd
+ http://cxf.apache.org/jaxrs
http://cxf.apache.org/schemas/jaxrs.xsd
+ http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd">
+ ...
+ <!-- JAXRS providers -->
+ <bean id="jsonProvider"
class="com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider" />
+
+ <!-- Application resources -->
+ <bean id="sampleResource" class="demo.jaxrs.swagger.server.Sample" />
+
+ <!-- CXF OpenApiFeature -->
+ <bean id="openApiFeature"
class="org.apache.cxf.jaxrs.openapi.OpenApiFeature">
+ <!-- customize some of the properties -->
+ </bean>
+
+ ...
+
+ <jaxrs:server id="sampleServer" address="/swaggerSample">
+ <jaxrs:serviceBeans>
+ <ref bean="sampleResource" />
+ </jaxrs:serviceBeans>
+ <jaxrs:providers>
+ <ref bean="jsonProvider" />
+ </jaxrs:providers>
+ <jaxrs:features>
+ <ref bean="openApiFeature" />
+ </jaxrs:features>
+ </jaxrs:server>
+</beans></pre>
+</div></div><p> </p><h1
id="OpenApiFeature-ConfiguringinBlueprint">Configuring in Blueprint</h1><p>In
case of Apache Karaf, the <a shape="rect" class="external-link"
href="https://github.com/OAI/OpenAPI-Specification/releases/tag/3.0.0";
rel="nofollow">OpenAPI v3.0</a> integration is available as
<strong>cxf-rs-description-openapi-v3</strong> feature.</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;">feature:install cxf-rs-description-openapi-v3</pre>
+</div></div><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;"><blueprint
xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xmlns:cxf="http://cxf.apache.org/blueprint/core";
+ xmlns:jaxrs="http://cxf.apache.org/blueprint/jaxrs";
+ xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0
http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd
+ http://cxf.apache.org/blueprint/core
http://cxf.apache.org/schemas/blueprint/core.xsd
+ http://cxf.apache.org/jaxrs
http://cxf.apache.org/schemas/blueprint/jaxrs.xsd">
+ ...
+ <!-- JAXRS providers -->
+ <bean id="jsonProvider"
class="com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider" />
+
+ <!-- Application resources -->
+ <bean id="sampleResource" class="demo.jaxrs.swagger.server.Sample" />
+
+
+ <!-- CXF OpenApiFeature -->
+ <bean id="openApiFeature"
class="org.apache.cxf.jaxrs.openapi.OpenApiFeature">
+ <!-- customize some of the properties -->
+ </bean>
+
+ ...
+
+ <jaxrs:server id="sampleServer" address="/swaggerSample">
+ <jaxrs:serviceBeans>
+ <ref component-id="sampleResource" />
+ </jaxrs:serviceBeans>
+ <jaxrs:providers>
+ <ref component-id="jsonProvider" />
+ </jaxrs:providers>
+ <jaxrs:features>
+ <ref component-id="openApiFeature" />
+ </jaxrs:features>
+ </jaxrs:server>
+</blueprint></pre>
+</div></div><p> </p><h1
id="OpenApiFeature-ConfiguringinCXFNonSpringJaxrsServlet">Configuring in
CXFNonSpringJaxrsServlet</h1><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;"><web-app>
+ <context-param>
+ <param-name>contextParam</param-name>
+ <param-value>contextParamValue</param-value>
+ </context-param>
+
+ <servlet>
+ <servlet-name>CXFServlet</servlet-name>
+ <display-name>CXF Servlet</display-name>
+
<servlet-class>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</servlet-class>
+ <init-param>
+ <param-name>jaxrs.serviceClasses</param-name>
+
<param-value>org.apache.cxf.systest.jaxrs.BookStore</param-value>
+ </init-param>
+ <init-param>
+ <param-name>jaxrs.features</param-name>
+
<param-value>org.apache.cxf.jaxrs.openapi.OpenApiFeature</param-value>
+ </init-param>
+ <load-on-startup>1</load-on-startup>
+ </servlet>
+
+ <servlet-mapping>
+ <servlet-name>CXFServlet</servlet-name>
+ <url-pattern>/*</url-pattern>
+ </servlet-mapping>
+
+</web-app></pre>
+</div></div><p> </p><p><span><span><span><br
clear="none"></span></span></span></p></div>
</div>
<!-- Content -->
</td>
