Comparaison des versions

Ancienne version 4

changes.mady.by.user Serge Vignello

Sauvegardée le

comparé à

Nouvelle version 5

changes.mady.by.user Serge Vignello

Sauvegardée le

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

...

Par défaut, les apis sont regroupées par programme/classe ; l'ordre d'affichage est celui défini par le "scan" des classes.

A. Regroupement

Les apis issues de différents programmes peuvent être regroupées à l'aide de Toutes les apis d'un service sont regroupées par défaut dans le même 'GroupName', celui défini implicitement ou explicitement via l'ordre : SW_CONFIGURER *SERVICE _WS_REST_SWAG_DESCRIPTION 'GroupName'.
Toutes les apis des services référençant le même GroupNamesont regroupées dans swaggerUi.

A partir d'Adélia Studio 13 PTF08, l'ordre SW_CONFIGURER s'enrichit de l'attribut _WS_REST_SWAG_TAGS.
Désormais les apis/opérations d'un même service peuvent être regroupées dans des groupes distincts.
L'ordre SW_CONFIGURER *SERVICE _WS_REST_SWAG_DESCRIPTION 'DescGroupName1,DescGroupName2' permet alors d'associer une description à chacun des noms de groupe.

Exemples :

Hardis bloc code adelia
Permet de définir les groupes/tags  du service.
 Hardis bloc code adelia
Permet d'affecter une api/opération à un (ou plusieurs) groupe(s)/tag(s).
B. Ordre
L'ordre d'affichage des classes/groupes peut être modifié a posteriori en modifiant le fichier swagger.html : définition de la propriété apisSorter de l'objet SwaggerUI.
...