Swagger est un ensemble d'outils open source pour documenter, concevoir et tester des API REST. La spécification OpenAPI (anciennement Swagger) est le standard de description d'API le plus utilisé au monde.
Qu'est-ce que Swagger ?
Swagger est un écosystème d'outils pour la conception, la documentation et le test d'API REST. La spécification OpenAPI (qui s'appelait initialement Swagger Specification) est devenue le standard mondial pour décrire les API RESTful de manière lisible par les machines et les humains.
Les composants Swagger
- Swagger UI : Interface web interactive pour explorer et tester les endpoints d'une API
- Swagger Editor : Éditeur en ligne pour écrire des spécifications OpenAPI en YAML/JSON
- Swagger Codegen : Générateur automatique de SDK clients dans plus de 40 langages
Avantages de Swagger/OpenAPI
- Documentation vivante : La doc est toujours synchronisée avec l'API réelle
- Test interactif : Testez chaque endpoint directement depuis le navigateur
- Génération de code : SDK clients générés automatiquement
Swagger chez AILabsAudit
AILabsAudit fournit une documentation Swagger interactive accessible à /api/v1/docs. Vous pouvez y explorer tous les endpoints, voir les schémas de requête/réponse et tester les appels directement avec votre clé API.