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 "swagger2Feature" dans l'élément <jaxrs:server><jaxrs:features>.
<jaxrs:server id="RestAdelia" address="/" transportId="http://cxf.apache.org/transports/http">
< !--jaxrs:features>
<ref bean="swagger2Feature" />
</jaxrs:features-->
</jaxrs:server>
La feature nommée "swagger2Feature" référencée dans l'élément <jaxrs:server> expose différents éléments de paramétrage :
<bean id="swagger2Feature" class="org.apache.cxf.jaxrs.swagger.Swagger2Feature">
<property name="basePath" value="/jaxrs/ws"/>
<property name="resourcePackage" value="hardis.jaxrs" />
<property name="contact" value="hardis group" />
<property name="title" value="REST Services List " />
<property name="description" value=" REST services documentation " />
<property name="version" value="1.0" />
<property name="termsOfServiceUrl" value="http://www.hardis-group.com" />
</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.
|
resourcePackage |
Définit une liste packages. Cette information délimite le périmètre des services REST à présenter.
|
contact title description version termsOfServiceUrl
|
Informations générales présentées sur la page de description des services |
Remarque : les propriétés basePath et resourcePackage sont automatiquement renseignées 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.