Comparaison des versions

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.

...

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.

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).

...

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.

Bloc de code
languagejs
window.swaggerUi = new SwaggerUi({
...
    apisSorter: "alpha",
    operationsSorter: function (a, b) {
    var order = { 'get': '0', 'post': '1', 'put': '2', 'delete': '3' };
    return order[a.method].localeCompare(order[b.method]);    
  },
...
})

...

- la fonction function(a,b) permet d'obtenir un tri en regard des valeurs retournées par la fonction de comparaison.


ou depuis Adelia Studio 13.9 (Cf. https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md), en modifiant le fichier index.html de l'archive swagger-ui-3.x.y

Bloc de code
languagejs
titleindex.html
const ui = SwaggerUIBundle({                
        url: ...,
        dom_id: '#swagger-ui',
        operationsSorter:{
           var order = { 'get': '0', 'post': '1', 'put': '2', 'delete': '3' };
           return order[a.method].localeCompare(order[b.method]);      
       },
	   tagsSorter:'alpha',
...
})