...
![]() Code Block |
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-swagger</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
|
Using
To use this The Swagger servlet is integrated with Spring or ServletListener Component.
| Component |
Servlet ClassName |
| spring |
org.apache.camel.component.swagger.spring.SpringRestSwaggerApiDeclarationServlet |
| servletlistener |
org.apache.camel.component.swagger.servletlistener.ServletListenerRestSwaggerApiDeclarationServlet |
The servlet support the same options when using spring or servletlistener.
When using Spring you need to configure the org.apache.camel.component.swagger.RestSwaggerApiDeclarationServletspring.SpringRestSwaggerApiDeclarationServlet in the WEB-INF/web.xml file as shown below:
![]() Code Block |
<!-- to setup Camel Swagger api servlet when using Spring -->
<servlet>
<servlet-name>ApiDeclarationServlet</servlet-name>
<servlet-class>org.apache.camel.component.swagger.RestSwaggerApiDeclarationServlet<spring.SpringRestSwaggerApiDeclarationServlet</servlet-class>
<init-param>
<param-name>base.path</param-name>
<param-value>http://localhost:8080/rest</param-value>
</init-param>
<init-param>
<param-name>api.path</param-name>
<param-value>http://localhost:8080/api-docs</param-value>
</init-param>
<init-param>
<param-name>api.version</param-name>
<param-value>1.2.3</param-value>
</init-param>
<init-param>
<param-name>api.title</param-name>
<param-value>User Services</param-value>
</init-param>
<init-param>
<param-name>api.description</param-name>
<param-value>Camel Rest Example with Swagger that provides an User REST service</param-value>
</init-param>
<load-on-startup>2</load-on-startup>
</servlet>
<!-- swagger api declaration -->
<servlet-mapping>
<servlet-name>ApiDeclarationServlet</servlet-name>
<url-pattern>/api-docs/*</url-pattern>
</servlet-mapping> |
...
