Monitoring API OpenAPI/Swagger
Validez que vos API respectent leur documentation.
OpenAPI (anciennement Swagger) est le standard de documentation des API REST. Mais une documentation ne garantit pas que l'API la respecte. Le monitoring permet de valider continuellement le contrat API.
Surveillez vos endpoints OpenAPI pour détecter les breaking changes, les régressions de schéma et les problèmes de compatibilité avant vos clients.
Pourquoi Surveiller avec OpenAPI
- Contract testing : validez que l'API respecte sa spécification documentée.
- Breaking changes : détectez les changements incompatibles avant déploiement.
- Documentation sync : assurez-vous que la doc reflète la réalité.
Quoi Surveiller
- Spec endpoint : surveillez l'accès à votre fichier openapi.json/yaml.
- Response schemas : validez que les réponses matchent les schémas définis.
- Required fields : vérifiez la présence des champs obligatoires.
Automatiser avec MoniTao
- Validation JSON : utilisez les assertions MoniTao pour valider les champs attendus.
- Multi-endpoints : créez un monitor par endpoint critique de votre spec.
Questions Fréquentes
Comment valider un schéma OpenAPI ?
MoniTao permet de vérifier la présence de champs et leurs valeurs. Pour une validation complète, combinez avec des tests CI.
Quelle version OpenAPI est supportée ?
MoniTao est agnostique - il surveille les endpoints HTTP, quelle que soit la version de spec.
Comment détecter les breaking changes ?
Surveillez les champs requis avec des assertions. Un champ manquant déclenche une alerte.
Puis-je surveiller Swagger UI ?
Oui, surveillez l'URL de votre Swagger UI pour vous assurer que la documentation reste accessible.
Liens utiles
Prêt à dormir sur vos deux oreilles ?
Commencez gratuitement, sans carte bancaire.