swagger

SWAGGER – LA DOCUMENTATION & TEST EN LIVE DE VOS WS

L’interface de documentation pour API la plus populaire au monde fait son entrée dans le Backend Apps Panel.

Vous êtes développeur ou suffisamment autodidacte pour comprendre le monde des Web Services, mais vous n’avez pas encore trouvé le bon outil pour documenter et tester en live vos WS REST ?

Swagger, la documentation pour les webservices REST

Si l’insuffisance de documentation pour vos WebService est bien connue, une solution (et plutôt une très bonne) existe tout de même : SWAGGER.

Essayez dès maintenant l’interface Swagger déjà au sein du Mobile Backend Apps Panel pour le développement de toutes vos applications mobiles.

Vous n’avez plus ni à écrire manuellement une documentation fastidieuse ni à la mettre à jour constamment, avec Swagger, cela est géré automatiquement. La cartographie de votre service, les verbes HTTP, les arguments utilisés ou les différentes versions de votre API sont à portée de main et surtout sous vos yeux !

Rangés par catégories, retrouvez vos webservices facilement et testez votre code en direct, sans devoir réécrire les URLs, grâce au module préconçu dans le backoffice.

swagger-module-2

Avec Swagger vous rendez visible l’ensemble de vos URLs et notamment la documentation des erreurs HTTP gérées par le serveur, un grand plus pour pouvoir apporter les correctifs nécessaires rapidement et simplement.

Par exemple, ce code sera retranscrit intelligemment en champs spécifiques :

Avant
/**
 * @method POST
 * @categorie Témoignages
 * @param string $nom_publication le titre du témoignage
 * @param string $description la description du témoignage
 * @param string $nom le nom de l'utilisateur
 * @param string $email l'email de l'utilisateur
 * @param file $image_temoignage le fichier vidéo du témoignage
 *
 */
 public function add_temoignage(){
 ...
 }
Après

bo-swagger

 

Swagger, l’UI au cœur des webservices

swagger-module

 

Autre avantage, que nous apprécions tout particulièrement, c’est le design

 spécifique, pensé pour une personne qui passe sa journée à développer et utiliser des APIs ! 

Swagger intègre en effet une interface d’utilisation à l’apparence très réussie ! Ce qui reconnaissez-le, est plutôt rare et plaisant dans l’environnement WS.

Retrouvez le sur le Backoffice Apps Panel dans la catégorie « Outils Dev » –> Documentation WS

 

 

swagger

 

 

 

 

 

 

 

 

Enfin un peu d’esthétique dans ce monde de code !

Un commentaire a été laissé sur l'article “SWAGGER – LA DOCUMENTATION & TEST EN LIVE DE VOS WS

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *


× 9 = quatre-vingt un

Vous pouvez utiliser ces balises et attributs HTML : <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>