La présentation d'un service Web REST s'affiche dans un navigateur Web :
- soit via la ressource http://mydomain.com/<Swagger2Feature$basePath>/services, puis en cliquant sur lien swagger proposé.
Par exemple : http://localhost:8080/awsbdcadel14/ws/services affiche la page suivante :
- Soit directement via la ressource http://mydomain.com/<Swagger2Feature$basePath>/api-docs?url=<Swagger2Feature$basePath>/swagger.json.
Par exemple : http://localhost:8080/awsbdcadel14/ws/api-docs?url=/awsbdcadel14/ws/swagger.json.
Remarque : la présentation n'est disponible que si, dans le fichier beans.xml, la propriété "supportSwaggerUi" du bean "swagger2Feature" a la valeur "true".
L'interface swagger ui affiche les services web de votre application web.
La section Models affiche les modèles de données utilisés dans les payloads des services web présentés.
Le bouton Authorise permet de saisir le jeton JWT dans le cas où vos services sont sécurisés en JWT.
Remarque : il est possible, que dans le cas d'un site créé en version 13 le bouton Authorise ne soit pas visible.
Cela se résout en modifiant dans le fichier beans.xml la property "resourcePackage" du bean "swagger2Feature", pour ajouter dans sa "value" le package "com.hardis.adelia.webservice" (value= "com.hardis.adelia.webservice,xxx.yyy.zzz" ).
En cliquant sur une opération, vous accédez à son détail :
Pour pouvoir exécuter l'opération, cliquez sur le bouton Try it out, pour pouvoir saisir vos données :
Cliquez ensuite sur le bouton Execute pour lancer l'exécution de l'opération et voir la réponse :