Marque-page Documenter et tester ses webservices avec Swagger

Si vous créez des webservices et les distribuez, il est utile de fournir également la documentation expliquant comment les utiliser.

Il existe un outil proposant une interface web pour tester des webservices, qui détaille également leur utilisation : Swagger.

Swagger UI

Cet outil gère tous les types de requête HTTP (GET, POST, PUT, DELETE, ...). Il permet d'envoyer des données au format JSON ou autre, d'afficher les réponses avec coloration syntaxique, les codes d'erreur, ...

Chaque webservice est détaillé dans une structure de données au format JSON. Cette structure peut être générée automatiquement pour de nombreux langages et Frameworks, notamment en utilisant des annotations particulières dans vos méthodes.