La présentation des services est réalisée à l'aide de l'interface Swagger-UI fournie en standard dans l'application Web.
Remarque : il est possible de désactiver cette présentation en modifiant le fichier de configuration /WEB-INF/beans.xml et en commentant la référence à la feature nommée "openApiFeature" dans l'élément <jaxrs:server><jaxrs:features>.
<jaxrs:server id="RestAdelia" address="/" transportId="http://cxf.apache.org/transports/http">
< !--jaxrs:features>
<ref bean="openApiFeature" />
</jaxrs:features-->
</jaxrs:server>
La feature nommée "openApiFeature" référencée dans l'élément <jaxrs:server> expose différents éléments de paramétrage :
<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>
Liste des propriétés :
basePath |
Définit l'URI de base. Cette information délimite le périmètre des services REST à présenter. |
title description version |
Informations générales présentées sur la page de description des services |
Remarque : la propriété basePath est automatiquement renseignée lors de la création d'un site au niveau des Attributs de l'environnement/Domaine > Informations au niveau logique > onglet Web/Client > bouton Créer/Actualiser le site.