Services are presented using the Swagger-UI interface supplied as standard in the Web application.
Note: this presentation can be disabled by changing the /WEB-INF/beans.xml configuration file and commenting the reference to the feature called "openApiFeature" in the <jaxrs:server><jaxrs:features> element.
<jaxrs:server id="RestAdelia" address="/" transportId="http://cxf.apache.org/transports/http"> < !--jaxrs:features> <ref bean="openApiFeature" /> </jaxrs:features--> </jaxrs:server>
The feature called "openApiFeature" referenced in the <jaxrs:server> element displays different configuration elements:
<bean id="openApiFeature" class="com.hardis.adelia.webservice.OpenApiFeatureExtended" lazy-init="true"> <property name="basePath" value="/jaxrs/ws"/> <property name="swguicfg_core_queryConfigEnabled" value="false"/> <property name="title" value="REST API - OPENAPIFEATURE"/> <property name="description" value="REST Api 2.0 OpenApiFeature description list"/> <property name="version" value="2.0"/> <property name="supportSwaggerUi" value="true"/> </bean>
List of properties:
basePath |
Defines the basic URI: This information delimits the scope of the REST services to present. |
title description version |
General information presented on the service description page. |
Note: the basePath property is automatically entered when creating a site in Environment attributes/Application area> Information at logical level > Web/Client tab > Create/Update site button.