Introduction

Ce plugin permet d'afficher tous les fichiers swagger au format JSON ou YAML présents sur un site et de les afficher sur une seule même page en utilisant l'UI Swagger.

Configuration

Il suffit de placer les fichiers en suivant cette arborescence : webapp/plugins/{nom-du-plugin}/api/swagger/v{numero-de-version}/{nom-du-fichier}[.json/.yaml]

En utilisant le pluginwizard, il crée et place le fichier swagger.json au bon endroit

Pour des API déployées sur plusieurs serveurs, il est possible d'utiliser dans les fichiers JSON ou YAML des variables host, port et context fournissant les valeurs du serveur d'exécution comme suit :

"host": "${host}:${port}",
"basePath": "${context}/rest/lutecetools"

ou en YAML

host: '${host}:${port}'
basePath: '${context}/rest/lutecetools'

Usage

Il ne reste qu'à accéder à la xpage swaggerui : /jsp/site/Portal.jsp?page=swaggerui

A noter que le plugin swaggerui n'affichera que les fichiers JSON ou YAML des plugins activés