La construction de la documentation est automatisée.
Le générateur Adélia Studio ajoute par défaut des informations Swagger dans les classes générées via des annotations spécifiques. Des informations complémentaires peuvent être ajoutées par le développeur pour enrichir la documentation à produire.
Ces compléments sont fournis à l'aide de l'ordre SW_CONFIGURER avec les noms d'attributs suivants :
'_swag_description'
|
Fournit une description/commentaire à une ressource.
|
'_swag_notes'
|
Fournit une description détaillée à une ressource.
|
'_swag_desc_param'
|
Fournit une description pour un paramètre en entrée de nature path, query, header ou form.
|
'_swag_response'
|
Fournit les différents codes HTTP (et des commentaires) que la ressource peut retourner. |
'_swag_extdoc_url'
|
Fournit un lien vers une documentation externe. |
'_swag_extdoc_desc'
|
Fournit une description pour le lien vers une documentation externe.
|
Se reporter à l'ordre SW_CONFIGURER pour plus de détail et des exemples d'utilisation.