Author: buildbot
Date: Mon Sep 21 10:47:51 2015
New Revision: 966198
Log:
Production update by buildbot for cxf
Added:
websites/production/cxf/content/docs/swaggerfeature-swagger2feature.html
Modified:
websites/production/cxf/content/cache/docs.pageCache
Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary files - no diff available.
Added: websites/production/cxf/content/docs/swaggerfeature-swagger2feature.html
==============================================================================
--- websites/production/cxf/content/docs/swaggerfeature-swagger2feature.html
(added)
+++ websites/production/cxf/content/docs/swaggerfeature-swagger2feature.html
Mon Sep 21 10:47:51 2015
@@ -0,0 +1,258 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+ <head>
+
+<link type="text/css" rel="stylesheet" href="/resources/site.css">
+<script src='/resources/space.js'></script>
+
+<meta http-equiv="Content-type" content="text/html;charset=UTF-8">
+<meta name="keywords" content="business integration, EAI, SOA, Service
Oriented Architecture, web services, SOAP, JBI, JMS, WSDL, XML, EDI, Electronic
Data Interchange, standards support, integration standards, application
integration, middleware, software, solutions, services, CXF, open source">
+<meta name="description" content="Apache CXF, Services Framework -
SwaggerFeature / Swagger2Feature">
+
+
+<link type="text/css" rel="stylesheet"
href="/resources/highlighter/styles/shCoreCXF.css">
+<link type="text/css" rel="stylesheet"
href="/resources/highlighter/styles/shThemeCXF.css">
+
+<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>
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+</script>
+
+
+ <title>
+Apache CXF -- SwaggerFeature / Swagger2Feature
+ </title>
+ </head>
+<body onload="init()">
+
+
+<table width="100%" cellpadding="0" cellspacing="0">
+ <tr>
+ <td id="cell-0-0" colspan="2"> </td>
+ <td id="cell-0-1"> </td>
+ <td id="cell-0-2" colspan="2"> </td>
+ </tr>
+ <tr>
+ <td id="cell-1-0"> </td>
+ <td id="cell-1-1"> </td>
+ <td id="cell-1-2">
+ <!-- Banner -->
+<div class="banner" id="banner"><div><table border="0" cellpadding="0"
cellspacing="0" width="100%"><tr><td align="left" colspan="1" nowrap>
+<a shape="rect" href="http://cxf.apache.org/"; title="Apache CXF"><span
style="font-weight: bold; font-size: 170%; color: white">Apache CXF</span></a>
+</td><td align="right" colspan="1" nowrap>
+<a shape="rect" href="http://www.apache.org/"; title="The Apache Sofware
Foundation"><img border="0" alt="ASF Logo"
src="http://cxf.apache.org/images/asf-logo.png";></a>
+</td></tr></table></div></div>
+ <!-- Banner -->
+ <div id="top-menu">
+ <table border="0" cellpadding="1" cellspacing="0" width="100%">
+ <tr>
+ <td>
+ <div align="left">
+ <!-- Breadcrumbs -->
+<a href="index.html">Index</a> > <a
href="configuration.html">Configuration</a> > <a
href="featureslist.html">FeaturesList</a> > <a
href="swaggerfeature-swagger2feature.html">SwaggerFeature / Swagger2Feature</a>
+ <!-- Breadcrumbs -->
+ </div>
+ </td>
+ <td>
+ <div align="right">
+ <!-- Quicklinks -->
+<div id="quicklinks"><p><a shape="rect"
href="http://cxf.apache.org/download.html";>Download</a> | <a shape="rect"
href="http://cxf.apache.org/docs/index.html";>Documentation</a></p></div>
+ <!-- Quicklinks -->
+ </div>
+ </td>
+ </tr>
+ </table>
+ </div>
+ </td>
+ <td id="cell-1-3"> </td>
+ <td id="cell-1-4"> </td>
+ </tr>
+ <tr>
+ <td id="cell-2-0" colspan="2"> </td>
+ <td id="cell-2-1">
+ <table>
+ <tr valign="top">
+ <td height="100%">
+ <div id="wrapper-menu-page-right">
+ <div id="wrapper-menu-page-top">
+ <div id="wrapper-menu-page-bottom">
+ <div id="menu-page">
+ <!-- NavigationBar -->
+<div id="navigation"><ul class="alternate"><li><a shape="rect"
href="overview.html">Overview</a></li><li><a shape="rect"
href="how-tos.html">How-Tos</a></li><li><a shape="rect"
href="frontends.html">Frontends</a></li><li><a shape="rect"
href="databindings.html">DataBindings</a></li><li><a shape="rect"
href="transports.html">Transports</a></li><li><a shape="rect"
href="configuration.html">Configuration</a></li><li><a shape="rect"
href="debugging-and-logging.html">Debugging and Logging</a></li><li><a
shape="rect" href="tools.html">Tools</a></li><li><a shape="rect"
href="restful-services.html">RESTful Services</a></li><li><a shape="rect"
href="wsdl-bindings.html">WSDL Bindings</a></li><li><a shape="rect"
href="service-routing.html">Service Routing</a></li><li><a shape="rect"
href="dynamic-languages.html">Dynamic Languages</a></li><li><a shape="rect"
href="ws-support.html">WS-* Support</a></li><li><a shape="rect"
href="advanced-integration.html">Advanced Integration</a></li><li><a shape
="rect" href="deployment.html">Deployment</a></li><li><a shape="rect"
href="schemas-and-namespaces.html">Use of Schemas and
Namespaces</a></li></ul><hr><ul
class="alternate"><li><p>Search</p></li></ul><form
enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box"
action="http://www.google.com/cse";>
+ <div>
+ <input type="hidden" name="cx" value="002890367768291051730:o99qiwa09y4">
+ <input type="hidden" name="ie" value="UTF-8">
+ <input type="text" name="q" size="21">
+ <input type="submit" name="sa" value="Search">
+ </div>
+</form>
+<script type="text/javascript"
src="http://www.google.com/cse/brand?form=cse-search-box&lang=en";></script><hr><ul
class="alternate"><li><a shape="rect"
href="http://cxf.apache.org/javadoc/latest/";>API 3.1.x (Javadoc)</a></li><li><a
shape="rect" href="http://cxf.apache.org/javadoc/latest-3.0.x/";>API 3.0.x
(Javadoc)</a></li><li><a shape="rect" href="http://cxf.apache.org/";>CXF
Website</a></li></ul></div>
+ <!-- NavigationBar -->
+ </div>
+ </div>
+ </div>
+ </div>
+ </td>
+ <td height="100%">
+ <!-- Content -->
+ <div class="wiki-content">
+<div id="ConfluenceContent"><h1
id="SwaggerFeature/Swagger2Feature-SwaggerFeature/Swagger2Feature">SwaggerFeature
/ Swagger2Feature</h1><p><style type="text/css">/*<![CDATA[*/
+div.rbtoc1442832427934 {padding: 0px;}
+div.rbtoc1442832427934 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1442832427934 li {margin-left: 0px;padding-left: 0px;}
+
+/*]]>*/</style></p><div class="toc-macro rbtoc1442832427934">
+<ul class="toc-indentation"><li><a shape="rect"
href="#SwaggerFeature/Swagger2Feature-SwaggerFeature/Swagger2Feature">SwaggerFeature
/ Swagger2Feature</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-Samples">Samples</a></li></ul>
+</div><p> </p><p>The CXF Swagger2Feature allows you to generate <a
shape="rect" class="external-link" href="http://swagger.io/specification/";
rel="nofollow">Swagger 2.0</a> documents from JAX-RS service endpoints
with a simple configuration.</p><p>For generating <a shape="rect"
class="external-link"
href="https://github.com/swagger-api/swagger-spec/blob/master/versions/1.2.md";
rel="nofollow">Swagger 1.2</a> documents, you can use SwaggerFeature instead of
Swagger2Feature.</p><p>These features can be configured programatically in Java
or using Spring or Blueprint beans.</p><h1
id="SwaggerFeature/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">"[email protected]"</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="confluenceT
d">"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 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 resources 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="confluence
Td">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></table></div><p>Note: those
descriptions marked with <span>+ correspond to the properties defined in
Swagger's BeanConfig, and those marked with <span>+</span><span>+
correspond to the properties defined in Swagger's
ReaderConfig.</span></span></p><h1
id="SwaggerFeature/Swagger2Feature-ConfiguringProgramatically">Configuring
Programatically</h1><p> </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();
+
+ // 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>
+</div></div><p> </p><h1
id="SwaggerFeature/Swagger2Feature-ConfiguringinSpring">Configuring in
Spring</h1><p> </p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: xml; 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 Swagger2Feature -->
+ <bean id="swagger2Feature"
class="org.apache.cxf.jaxrs.swagger.Swagger2Feature">
+ <!-- customize some of the properties -->
+ <property name="basePath" value="/app/swaggerSample"/>
+ </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="swagger2Feature" />
+ </jaxrs:features>
+ </jaxrs:server>
+</beans>
+
+</pre>
+</div></div><p> </p><h1
id="SwaggerFeature/Swagger2Feature-ConfiguringinBlueprint">Configuring in
Blueprint</h1><p> </p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: xml; 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 Swagger2Feature -->
+ <bean id="swagger2Feature"
class="org.apache.cxf.jaxrs.swagger.Swagger2Feature">
+ <!-- customize some of the properties -->
+ <property name="basePath" value="/cxf/swaggerSample"/>
+ </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="swagger2Feature" />
+ </jaxrs:features>
+ </jaxrs:server>
+</blueprint>
+ </pre>
+</div></div><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>: Swagger 2.0
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_web";
rel="nofollow">samples/jax_rs/description_swagger2_web</a>: 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>: Swagger 2.0
OSGi application sample using Swagger2Feature using Blueprint<br
clear="none"><br clear="none"></li></ul><p> </p></div>
+ </div>
+ <!-- Content -->
+ </td>
+ </tr>
+ </table>
+ </td>
+ <td id="cell-2-2" colspan="2"> </td>
+ </tr>
+ <tr>
+ <td id="cell-3-0"> </td>
+ <td id="cell-3-1"> </td>
+ <td id="cell-3-2">
+ <div id="footer">
+ <!-- Footer -->
+ <div id="site-footer">
+ <a href="http://cxf.apache.org/privacy-policy.html";>Privacy
Policy</a> -
+ (<a
href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=61318164";>edit
page</a>)
+ (<a
href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61318164&showComments=true&showCommentArea=true#addcomment";>add
comment</a>)<br>
+ Apache CXF, CXF, Apache, the Apache feather logo are trademarks of The
Apache Software Foundation.<br>
+ All other marks mentioned may be trademarks or registered trademarks
of their respective owners.
+ </div>
+ <!-- Footer -->
+ </div>
+ </td>
+ <td id="cell-3-3"> </td>
+ <td id="cell-3-4"> </td>
+ </tr>
+ <tr>
+ <td id="cell-4-0" colspan="2"> </td>
+ <td id="cell-4-1"> </td>
+ <td id="cell-4-2" colspan="2"> </td>
+ </tr>
+</table>
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl."; :
"http://www.";);
+document.write(unescape("%3Cscript src='" + gaJsHost +
"google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-4458903-1");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
+</body>
+</html>
+
![http://cxf.apache.org/images/asf-logo.png"](http://cxf.apache.org/images/asf-logo.png"){kind=link}